mongodb-memory-server-core
Version:
MongoDB Server for testing (core package, without autodownload). The server will allow you to connect your favourite ODM or client library to the MongoDB Server and run parallel integration tests isolated from each other.
101 lines • 3.78 kB
TypeScript
/// <reference types="node" />
import { URL } from 'url';
import https from 'https';
import { MongoBinaryOpts } from './MongoBinary';
export interface MongoBinaryDownloadProgress {
current: number;
length: number;
totalMb: number;
lastPrintedAt: number;
}
/**
* Download and extract the "mongod" binary
*/
export declare class MongoBinaryDownload {
dlProgress: MongoBinaryDownloadProgress;
_downloadingUrl?: string;
/**These options are kind of raw, they are not run through DryMongoBinary.generateOptions */
binaryOpts: Required<MongoBinaryOpts>;
get checkMD5(): boolean;
set checkMD5(val: boolean);
get downloadDir(): string;
set downloadDir(val: string);
get arch(): string;
set arch(val: string);
get version(): string;
set version(val: string);
get platform(): string;
set platform(val: string);
constructor(opts: MongoBinaryOpts);
/**
* Get the full path with filename
* @returns Absoulte Path with FileName
*/
protected getPath(): Promise<string>;
/**
* Get the path of the already downloaded "mongod" file
* otherwise download it and then return the path
*/
getMongodPath(): Promise<string>;
/**
* Download the MongoDB Archive and check it against an MD5
* @returns The MongoDB Archive location
*/
startDownload(): Promise<string>;
/**
* Download MD5 file and check it against the MongoDB Archive
* @param urlForReferenceMD5 URL to download the MD5
* @param mongoDBArchive The MongoDB Archive file location
*
* @returns {undefined} if "checkMD5" is falsey
* @returns {true} if the md5 check was successful
* @throws if the md5 check failed
*/
makeMD5check(urlForReferenceMD5: string, mongoDBArchive: string): Promise<boolean | undefined>;
/**
* Download file from downloadUrl
* @param downloadUrl URL to download a File
* @returns The Path to the downloaded archive file
*/
download(downloadUrl: string): Promise<string>;
/**
* Extract given Archive
* @param mongoDBArchive Archive location
* @returns extracted directory location
*/
extract(mongoDBArchive: string): Promise<string>;
/**
* Extract a .tar.gz archive
* @param mongoDBArchive Archive location
* @param extractPath Directory to extract to
* @param filter Method to determine which files to extract
*/
extractTarGz(mongoDBArchive: string, extractPath: string, filter: (file: string) => boolean): Promise<void>;
/**
* Extract a .zip archive
* @param mongoDBArchive Archive location
* @param extractPath Directory to extract to
* @param filter Method to determine which files to extract
*/
extractZip(mongoDBArchive: string, extractPath: string, filter: (file: string) => boolean): Promise<void>;
/**
* Downlaod given httpOptions to tempDownloadLocation, then move it to downloadLocation
* @param httpOptions The httpOptions directly passed to https.get
* @param downloadLocation The location the File should be after the download
* @param tempDownloadLocation The location the File should be while downloading
*/
httpDownload(url: URL, httpOptions: https.RequestOptions, downloadLocation: string, tempDownloadLocation: string): Promise<string>;
/**
* Print the Download Progress to STDOUT
* @param chunk A chunk to get the length
*/
printDownloadProgress(chunk: {
length: number;
}, forcePrint?: boolean): void;
/**
* Helper function to de-duplicate assigning "_downloadingUrl"
*/
assignDownloadingURL(url: URL): string;
}
export default MongoBinaryDownload;
//# sourceMappingURL=MongoBinaryDownload.d.ts.map