Class MongoBinaryDownload

constructor

• new MongoBinaryDownload(opts): MongoBinaryDownload

• Parameters

  • opts: MongoBinaryOpts

  Returns MongoBinaryDownload

binaryOpts

dlProgress

assignDownloadingURL

• assignDownloadingURL(url): string

• Helper function to de-duplicate assigning "_downloadingUrl"

  Parameters

  • url: URL

  Returns string

download

• download(downloadUrl): Promise<string>

• Download file from downloadUrl

  Parameters

  • downloadUrl: string

    URL to download a File

  Returns Promise<string>

  The Path to the downloaded archive file

extract

• extract(mongoDBArchive): Promise<string>

• Extract given Archive

  Parameters

  • mongoDBArchive: string

    Archive location

  Returns Promise<string>

  extracted directory location

extractTarGz

• extractTarGz(mongoDBArchive, extractPath, filter): Promise<void>

• Extract a .tar.gz archive

  Parameters

  • mongoDBArchive: string

    Archive location

  • extractPath: string

    Directory to extract to

  • filter: ((file) => boolean)

    Method to determine which files to extract

    • • (file): boolean

      • Parameters

        • file: string

        Returns boolean

  Returns Promise<void>

extractZip

• extractZip(mongoDBArchive, extractPath, filter): Promise<void>

• Extract a .zip archive

  Parameters

  • mongoDBArchive: string

    Archive location

  • extractPath: string

    Directory to extract to

  • filter: ((file) => boolean)

    Method to determine which files to extract

    • • (file): boolean

      • Parameters

        • file: string

        Returns boolean

  Returns Promise<void>

getMongodPath

• getMongodPath(): Promise<string>

• Get the path of the already downloaded "mongod" file otherwise download it and then return the path

  Returns Promise<string>

httpDownload

• httpDownload(url, httpOptions, downloadLocation, tempDownloadLocation): Promise<string>

• Downlaod given httpOptions to tempDownloadLocation, then move it to downloadLocation

  Parameters

  • url: URL

  • httpOptions: RequestOptions

    The httpOptions directly passed to https.get

  • downloadLocation: string

    The location the File should be after the download

  • tempDownloadLocation: string

    The location the File should be while downloading

  Returns Promise<string>

makeMD5check

• makeMD5check(urlForReferenceMD5, mongoDBArchive): Promise<undefined | boolean>

• Download MD5 file and check it against the MongoDB Archive

  Parameters

  • urlForReferenceMD5: string

    URL to download the MD5

  • mongoDBArchive: string

    The MongoDB Archive file location

  Returns Promise<undefined | boolean>

  if "checkMD5" is falsey

  Throws

  if the md5 check failed

printDownloadProgress

• printDownloadProgress(chunk, forcePrint?): void

• Print the Download Progress to STDOUT

  Parameters

  • chunk: {
        length: number;
    }

    A chunk to get the length

    • length: number

  • forcePrint: boolean = false

  Returns void

startDownload

• startDownload(): Promise<string>

• Download the MongoDB Archive and check it against an MD5

  Returns Promise<string>

  The MongoDB Archive location