Protected _binaryOptions for the Binary across all instances
-Protected _instanceOptions for individual instances
-Protected Optional _keyfiletmpTMPDIR for the keyfile, when auth is used
-Protected _ranProtected _replOptions for the Replset itself and defaults for instances
-Protected _stateAll servers this ReplSet instance manages
-Static Readonly captureStatic captureSets or gets the default captureRejection value for all emitters.
+Protected _binaryOptions for the Binary across all instances
+Protected _instanceOptions for individual instances
+Protected Optional _keyfiletmpTMPDIR for the keyfile, when auth is used
+Protected _ranProtected _replOptions for the Replset itself and defaults for instances
+Protected _stateAll servers this ReplSet instance manages
+Static Readonly captureStatic captureSets or gets the default captureRejection value for all emitters.
Static defaultStatic Readonly errorThis symbol shall be used to install a listener for only monitoring 'error'
events. Listeners installed using this symbol are called before the regular
'error' listeners are called.
'error' listener is installed.
Get & Set "binaryOpts"
if "state" is not "stopped"
-Get & Set "instanceOpts"
+Get & Set "instanceOpts"
if "state" is not "stopped"
-Get & Set "replSetOpts" +
Get & Set "replSetOpts" (Applies defaults)
if "state" is not "stopped"
-Get Current state of this class
-Protected _initConnects to the first server from the list of servers and issues the replSetInitiate
+
Get Current state of this class
+Protected _initConnects to the first server from the list of servers and issues the replSetInitiate
command passing in a new replica set configuration object.
if state is not "init"
if "servers.length" is not 1 or above
if package "mongodb" is not installed
-Protected _initCreate the one Instance (without starting them)
+Protected _initCreate the one Instance (without starting them)
Instance Options to use for this instance
-Protected _waitProtected _waitWait until the replSet has elected a Primary
Timeout to not run infinitly, default: 30s
Optional where: stringExtra Parameter for logging to know where this function was called
if timeout is reached
-Remove the defined dbPath's
Optional options: CleanupSet how to run a cleanup, by default { doCleanup: true } is used
If "state" is not "stopped"
If "instanceInfo" is not defined
If an fs error occured
-Rest ...args: any[]Protected enableRest ...args: any[]Protected enableProtected ensureEnsure "_keyfiletmp" is defined
+Protected ensureReturns an array listing the events for which the emitter has registered +
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or Symbols.
const EventEmitter = require('events');
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});
const sym = Symbol('symbol');
myEE.on(sym, () => {});
console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
If an fs error occured
Protected getReturns instance options suitable for a MongoMemoryServer.
Options to merge with
Optional keyfileLocation: stringThe Keyfile location if "auth" is used
-Returns the current max listener value for the EventEmitter which is either
set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.
v1.0.0
an valid mongo URI, by the definition of https://docs.mongodb.com/manual/reference/connection-string/
if state is not "running"
if an server doesnt have "instanceInfo.port" defined
-Protected initProtected initRest ...args: any[]Rest ...args: any[]Rest ...args: any[]Rest ...args: any[]Adds the listener function to the beginning of the listeners array for the
event named eventName. No checks are made to see if the listener has
already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple
times.
if an server doesnt have "instanceInfo.port" defined
v0.3.5
Protected stateProtected stateChange "this._state" to "newState" and emit "newState"
The new State to set & emit
-Rest ...args: any[]Stop the underlying mongod instance(s).
Optional cleanupOptions: CleanupSet how to run ".cleanup", by default only { doCleanup: true } is used
Static createCreate an instance of "MongoMemoryReplSet" and call start
+Static createCreate an instance of "MongoMemoryReplSet" and call start
Optional opts: Partial<MongoMemoryReplSetOpts>Options for the ReplSet
-Static getReturns a copy of the array of listeners for the event named eventName.
Static getReturns a copy of the array of listeners for the event named eventName.
For EventEmitters this behaves exactly the same as calling .listeners on
the emitter.
For EventTargets this is the only way to get the event listeners for the
diff --git a/typedoc/classes/MongoMemoryServer.MongoMemoryServer.html b/typedoc/classes/MongoMemoryServer.MongoMemoryServer.html
index 11e75427..fa83e3eb 100644
--- a/typedoc/classes/MongoMemoryServer.MongoMemoryServer.html
+++ b/typedoc/classes/MongoMemoryServer.MongoMemoryServer.html
@@ -1,5 +1,5 @@
This Class is used to have unified types for advanced-manager functions
-Create a Mongo-Memory-Sever Instance
Optional opts: MongoMemoryServerOptsMongo-Memory-Sever Options
-Protected Optional _instanceInformation about the started instance
-Protected _stateThe Current State of this instance
-Optional Readonly authOriginal Auth Configuration (this.opts can be changed if stopped, but auth cannot be changed here)
-General Options for this Instance
-Static Readonly captureStatic captureSets or gets the default captureRejection value for all emitters.
+Protected Optional _instanceInformation about the started instance
+Protected _stateThe Current State of this instance
+Optional Readonly authOriginal Auth Configuration (this.opts can be changed if stopped, but auth cannot be changed here)
+General Options for this Instance
+Static Readonly captureStatic captureSets or gets the default captureRejection value for all emitters.
Static defaultStatic Readonly errorThis symbol shall be used to install a listener for only monitoring 'error'
events. Listeners installed using this symbol are called before the regular
'error' listeners are called.
'error' event is emitted, therefore the process will still crash if no
regular 'error' listener is installed.
Get Information about the currently running instance, if it is not running it returns "undefined"
-Get Current state of this class
-Alias for emitter.on(eventName, listener).
Get Current state of this class
+Protected authRemove the defined dbPath
+Remove the defined dbPath
Optional options: CleanupSet how to run a cleanup, by default { doCleanup: true } is used
If "state" is not "stopped"
If "instanceInfo" is not defined
If an fs error occured
-Protected debugProtected debugRest ...args: any[]Ensure that the instance is running +
Rest ...extra: unknown[]Rest ...args: any[]Ensure that the instance is running -> throws if instance cannot be started
-Returns an array listing the events for which the emitter has registered +
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or Symbols.
const EventEmitter = require('events');
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});
const sym = Symbol('symbol');
myEE.on(sym, () => {});
console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
If an fs error occured
v1.0.0
Protected getProtected getConstruct Instance Starting Options
+Protected getConstruct Instance Starting Options
Force to use the port defined in options.instance (disabled port generation)
Generate the Connection string used by mongodb
Optional otherDb: stringadd a database into the uri (in mongodb its the auth database, in mongoose its the default database for models)
Optional otherIp: stringchange the ip in the generated uri, default will otherwise always be "127.0.0.1"
a valid mongo URI, by the definition of https://docs.mongodb.com/manual/reference/connection-string/
if state is not "running" (or "starting")
if a server doesnt have "instanceInfo.port" defined
-Rest ...args: any[]Rest ...args: any[]Rest ...args: any[]Rest ...args: any[]Adds the listener function to the beginning of the listeners array for the
event named eventName. No checks are made to see if the listener has
already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple
times.
if a server doesnt have "instanceInfo.port" defined<
Protected stateProtected stateChange "this._state" to "newState" and emit "stateChange" with "newState"
The new State to set & emit
-Stop the current In-Memory Instance
Optional cleanupOptions: CleanupSet how to run ".cleanup", by default only { doCleanup: true } is used
Static createCreate a Mongo-Memory-Sever Instance that can be awaited
+Static createCreate a Mongo-Memory-Sever Instance that can be awaited
Optional opts: MongoMemoryServerOptsMongo-Memory-Sever Options
-Static getReturns a copy of the array of listeners for the event named eventName.
Static getReturns a copy of the array of listeners for the event named eventName.
For EventEmitters this behaves exactly the same as calling .listeners on
the emitter.
For EventTargets this is the only way to get the event listeners for the
diff --git a/typedoc/classes/util_DryMongoBinary.DryMongoBinary.html b/typedoc/classes/util_DryMongoBinary.DryMongoBinary.html
index 232eb5ec..f0993d49 100644
--- a/typedoc/classes/util_DryMongoBinary.DryMongoBinary.html
+++ b/typedoc/classes/util_DryMongoBinary.DryMongoBinary.html
@@ -1,5 +1,5 @@
Locate an Binary, without downloading / locking
-Static binaryBinaries already found, values are: [Version, Path]
-Static combineStatic generateStatic combineStatic generateStatic generateGenerate All required options for the binary name / path generation
-Optional opts: BaseDryMongoBinaryOptionsStatic generateGenerate an "MongoBinaryPaths" object
+Static generateGenerate All required options for the binary name / path generation
+Optional opts: BaseDryMongoBinaryOptionsStatic generateGenerate an "MongoBinaryPaths" object
This Function should not hit the FileSystem
an finished "MongoBinaryPaths" object
-Static getGet the full path with filename
+Static getStatic getEnsure the given options fulfill DryMongoBinaryOptions by defaulting them
+Static getEnsure the given options fulfill DryMongoBinaryOptions by defaulting them
Optional opts: BaseDryMongoBinaryOptionsThe options to ensure
The ensured options
-Static getProbe if the provided "systemBinary" is an existing path
+Static getStatic locateTry to locate an existing binary
+Static locateTry to locate an existing binary
The Path to an Binary Found, or undefined
-Static parseParse "input" into DryMongoBinaryOptions
+Static parseParse "input" into DryMongoBinaryOptions
The Input to be parsed with the regex
The Options which will be augmented with "input"
The Augmented options
-Class used to combine "DryMongoBinary" & "MongoBinaryDownload"
-Static downloadProbe download path and download the binary
Options Configuring which binary to download and to which path
The BinaryPath the binary has been downloaded to
-Static getProbe all supported paths for an binary and return the binary path
+Static getProbe all supported paths for an binary and return the binary path
Options configuring which binary to search for
The first found BinaryPath
if no valid BinaryPath has been found
-Download and extract the "mongod" binary
-Protected Optional _downloadingThese options are kind of raw, they are not run through DryMongoBinary.generateOptions
-Protected Optional _downloadingThese options are kind of raw, they are not run through DryMongoBinary.generateOptions
+Extract given Archive
+Extract a .tar.gz archive
+Extract a .tar.gz archive
Archive location
Directory to extract to
Method to determine which files to extract
-Extract a .zip archive
Archive location
Directory to extract to
Method to determine which files to extract
-Protected getProtected getDownlaod given httpOptions to tempDownloadLocation, then move it to downloadLocation
+Downlaod given httpOptions to tempDownloadLocation, then move it to downloadLocation
The httpOptions directly passed to https.get
The location the File should be after the download
The location the File should be while downloading
-Download MD5 file and check it against the MongoDB Archive
URL to download the MD5
The MongoDB Archive file location
if "checkMD5" is falsey
if the md5 check failed
-
Class for managing an replSet
-