Class MongoBinary

Class used to combine "DryMongoBinary" & "MongoBinaryDownload"

Hierarchy

MongoBinary

Index

Constructors

constructor

Methods

Constructors

constructor

new MongoBinary(): MongoBinary

Returns MongoBinary

Methods

Static download

download(options: Required<MongoBinaryOpts>): Promise<string>

- Defined in packages/mongodb-memory-server-core/src/util/MongoBinary.ts:27
Probe download path and download the binary

Parameters
- options: Required<MongoBinaryOpts>
  
  Options Configuring which binary to download and to which path
Returns Promise<string>

The BinaryPath the binary has been downloaded to

Static getPath

getPath(opts?: MongoBinaryOpts): Promise<string>

- Defined in packages/mongodb-memory-server-core/src/util/MongoBinary.ts:73
Probe all supported paths for an binary and return the binary path

throws

{Error} if no valid BinaryPath has been found

Parameters
- opts: MongoBinaryOpts = {}
  
  Options configuring which binary to search for
Returns Promise<string>

The first found BinaryPath

Generated using TypeDoc