Class DryMongoBinary

constructor

• new DryMongoBinary(): DryMongoBinary

• Returns DryMongoBinary

Static binaryCache

Static combineBinaryName

• combineBinaryName(basePath, binaryName): string

• Combine basePath with binaryName

  Parameters

  • basePath: string

  • binaryName: string

  Returns string

Static generateDownloadPath

• generateDownloadPath(opts): Promise<[boolean, string]>

• Generate the Path where an Binary will be located

  Parameters

  • opts: DryMongoBinaryOptions & DryMongoBinaryNameOptions

  Returns Promise<[boolean, string]>

  "boolean" indicating if the binary exists at the provided path, and "string" the path to use for the binary

Static generateOptions

• generateOptions(opts?): Promise<Required<DryMongoBinaryOptions>>

• Generate All required options for the binary name / path generation

  Parameters

  • Optional opts: BaseDryMongoBinaryOptions

  Returns Promise<Required<DryMongoBinaryOptions>>

Static generatePaths

• generatePaths(opts): Promise<DryMongoBinaryPaths>

• Generate an "MongoBinaryPaths" object

  This Function should not hit the FileSystem

  Parameters

  • opts: DryMongoBinaryOptions & DryMongoBinaryNameOptions

  Returns Promise<DryMongoBinaryPaths>

  an finished "MongoBinaryPaths" object

Static getBinaryName

• getBinaryName(opts): Promise<string>

• Get the full path with filename

  Parameters

  • opts: DryMongoBinaryNameOptions

  Returns Promise<string>

  Absoulte Path with FileName

Static getEnsuredOptions

• getEnsuredOptions(opts?): DryMongoBinaryOptions

• Ensure the given options fulfill DryMongoBinaryOptions by defaulting them

  Parameters

  • Optional opts: BaseDryMongoBinaryOptions

    The options to ensure

  Returns DryMongoBinaryOptions

  The ensured options

Static getSystemPath

• getSystemPath(systemBinary): Promise<undefined | string>

• Probe if the provided "systemBinary" is an existing path

  Parameters

  • systemBinary: string

    The Path to probe for an System-Binary

  Returns Promise<undefined | string>

  System Binary path or undefined

Static locateBinary

• locateBinary(opts): Promise<undefined | string>

• Try to locate an existing binary

  Parameters

  • opts: DryMongoBinaryOptions

  Returns Promise<undefined | string>

  The Path to an Binary Found, or undefined

Static parseArchiveNameRegex

• parseArchiveNameRegex(input, opts): Required<DryMongoBinaryOptions>

• Parse "input" into DryMongoBinaryOptions

  Parameters

  • input: string

    The Input to be parsed with the regex

  • opts: Required<DryMongoBinaryOptions>

    The Options which will be augmented with "input"

  Returns Required<DryMongoBinaryOptions>

  The Augmented options