Class DryMongoBinary

constructor

• new DryMongoBinary(): DryMongoBinary

  Returns DryMongoBinary

StaticbinaryCache

StaticcombineBinaryName

• combineBinaryName(basePath: string, binaryName: string): string

  Combine basePath with binaryName

  Parameters

  • basePath: string
  • binaryName: string

  Returns string

StaticgenerateDownloadPath

• generateDownloadPath(
      opts: DryMongoBinaryOptions & DryMongoBinaryNameOptions,
  ): 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

StaticgenerateOptions

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

  Generate All required options for the binary name / path generation

  Parameters

  • Optionalopts: BaseDryMongoBinaryOptions

  Returns Promise<Required<DryMongoBinaryOptions>>

StaticgeneratePaths

• generatePaths(
      opts: DryMongoBinaryOptions & DryMongoBinaryNameOptions,
  ): Promise<DryMongoBinaryPaths>

  Generate an "MongoBinaryPaths" object

  This Function should not hit the FileSystem

  Parameters

  • opts: DryMongoBinaryOptions & DryMongoBinaryNameOptions

  Returns Promise<DryMongoBinaryPaths>

  an finished "MongoBinaryPaths" object

StaticgetBinaryName

• getBinaryName(opts: DryMongoBinaryNameOptions): Promise<string>

  Get the full path with filename

  Parameters

  • opts: DryMongoBinaryNameOptions

  Returns Promise<string>

  Absoulte Path with FileName

StaticgetEnsuredOptions

• getEnsuredOptions(opts?: BaseDryMongoBinaryOptions): DryMongoBinaryOptions

  Ensure the given options fulfill DryMongoBinaryOptions by defaulting them

  Parameters

  • Optionalopts: BaseDryMongoBinaryOptions

    The options to ensure

  Returns DryMongoBinaryOptions

  The ensured options

StaticgetSystemPath

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

  Probe if the provided "systemBinary" is an existing path

  Parameters

  • systemBinary: string

    The Path to probe for an System-Binary

  Returns Promise<string | undefined>

  System Binary path or undefined

StaticlocateBinary

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

  Try to locate an existing binary

  Parameters

  • opts: DryMongoBinaryOptions

  Returns Promise<string | undefined>

  The Path to an Binary Found, or undefined

StaticparseArchiveNameRegex

• parseArchiveNameRegex(
      input: string,
      opts: Required<DryMongoBinaryOptions>,
  ): 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