Class MongoBinary

Class used to combine "DryMongoBinary" & "MongoBinaryDownload"

Hierarchy

MongoBinary

Index

Constructors

Methods

download getPath

Constructors

constructor

new MongoBinary(): MongoBinary
Returns MongoBinary

Methods

`Static` download

download(options): Promise<string>
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
- Defined in packages/mongodb-memory-server-core/src/util/MongoBinary.ts:26

`Static` getPath

getPath(opts?): Promise<string>
Probe all supported paths for an binary and return the binary path
Parameters
- opts: MongoBinaryOpts = {}
  
  Options configuring which binary to search for
Returns Promise<string>
The first found BinaryPath

Throws
if no valid BinaryPath has been found
- Defined in packages/mongodb-memory-server-core/src/util/MongoBinary.ts:72

Generated using TypeDoc