MongoMemoryReplSet | mongodb-memory-server-core

Class for managing an replSet

Hierarchy

EventEmitter
- MongoMemoryReplSet

Implements

ManagerAdvanced

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new MongoMemoryReplSet(opts?: Partial<MongoMemoryReplSetOpts>): MongoMemoryReplSet

Inherited from EventEmitter.constructor
- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:169
Parameters
- opts: Partial<MongoMemoryReplSetOpts> = {}
Returns MongoMemoryReplSet

Properties

Protected _binaryOpts

_binaryOpts: MongoBinaryOpts

Options for the Binary across all instances

Protected _instanceOpts

_instanceOpts: MongoMemoryInstanceOptsBase[]

Options for individual instances

Protected Optional _keyfiletmp

_keyfiletmp: string

TMPDIR for the keyfile, when auth is used

Protected _ranCreateAuth

_ranCreateAuth: boolean = false

Protected _replSetOpts

_replSetOpts: Required<ReplSetOpts>

Options for the Replset itself and defaults for instances

Protected _state

_state: MongoMemoryReplSetStates = ...

servers

servers: MongoMemoryServer[] = []

All servers this ReplSet instance manages

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This 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.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Accessors

binaryOpts

get binaryOpts(): MongoBinaryOpts
set binaryOpts(val: MongoBinaryOpts): void

- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:222
Get & Set "binaryOpts"

throws

if "state" is not "stopped"

Returns MongoBinaryOpts
- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:226
Get & Set "binaryOpts"

Parameters
- val: MongoBinaryOpts
Returns void

instanceOpts

get instanceOpts(): MongoMemoryInstanceOptsBase[]
set instanceOpts(val: MongoMemoryInstanceOptsBase[]): void

- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:209
Get & Set "instanceOpts"

throws

if "state" is not "stopped"

Returns MongoMemoryInstanceOptsBase[]
- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:213
Get & Set "instanceOpts"

Parameters
- val: MongoMemoryInstanceOptsBase[]
Returns void

replSetOpts

get replSetOpts(): ReplSetOpts
set replSetOpts(val: ReplSetOpts): void

- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:236
Get & Set "replSetOpts" (Applies defaults)

throws

if "state" is not "stopped"

Returns ReplSetOpts
- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:240
Get & Set "replSetOpts" (Applies defaults)

Parameters
- val: ReplSetOpts
Returns void

state

get state(): MongoMemoryReplSetStates

- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:201
Get Current state of this class

Returns MongoMemoryReplSetStates

Methods

Protected _initReplSet

_initReplSet(): Promise<void>

- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:668
Connects to the first server from the list of servers and issues the replSetInitiate command passing in a new replica set configuration object.

throws

if state is not "init"

throws

if "servers.length" is not 1 or above

throws

if package "mongodb" is not installed

Returns Promise<void>

Protected _initServer

_initServer(instanceOpts: MongoMemoryInstanceOpts): MongoMemoryServer

- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:756
Create the one Instance (without starting them)

Parameters
- instanceOpts: MongoMemoryInstanceOpts
  
  Instance Options to use for this instance
Returns MongoMemoryServer

Protected _waitForPrimary

_waitForPrimary(timeout?: number, where?: string): Promise<void>

- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:774
Wait until the replSet has elected a Primary

throws

if timeout is reached

Parameters
- timeout: number = ...
  
  Timeout to not run infinitly, default: 30s
- Optional where: string
  
  Extra Parameter for logging to know where this function was called
Returns Promise<void>

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): MongoMemoryReplSet

Inherited from EventEmitter.addListener
- Defined in node_modules/@types/node/events.d.ts:57
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns MongoMemoryReplSet

cleanup

cleanup(force: boolean): Promise<void>
cleanup(options?: Cleanup): Promise<void>

- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:575
Remove the defined dbPath's

throws

If "state" is not "stopped"

throws

If "instanceInfo" is not defined

throws

If an fs error occured

deprecated

replace argument with Cleanup interface object

Parameters
- force: boolean
  
  Remove the dbPath even if it is no "tmpDir" (and re-check if tmpDir actually removed it)
Returns Promise<void>
- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:583
Remove the defined dbPath's

throws

If "state" is not "stopped"

throws

If "instanceInfo" is not defined

throws

If an fs error occured

Parameters
- Optional options: Cleanup
  
  Set how to run a cleanup, by default { doCleanup: true } is used
Returns Promise<void>

emit

emit(event: stateChange, ...args: any[]): boolean

Overrides EventEmitter.emit
- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:142
Parameters
- event: stateChange
- Rest ...args: any[]
Returns boolean

Protected enableAuth

enableAuth(): boolean

- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:273
Helper function to determine if "auth" should be enabled This function expectes to be run after the auth object has been transformed to a object

Returns boolean

"true" when "auth" should be enabled

Protected ensureKeyFile

ensureKeyFile(): Promise<string>

- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:481
Ensure "_keyfiletmp" is defined

Returns Promise<string>

the ensured "_keyfiletmp" value

eventNames

eventNames(): (string | symbol)[]

Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:72
Returns (string | symbol)[]

Protected getInstanceOpts

getInstanceOpts(baseOpts?: MongoMemoryInstanceOptsBase, keyfileLocation?: string): MongoMemoryInstanceOpts

- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:290
Returns instance options suitable for a MongoMemoryServer.

Parameters
- baseOpts: MongoMemoryInstanceOptsBase = {}
  
  Options to merge with
- Optional keyfileLocation: string
  
  The Keyfile location if "auth" is used
Returns MongoMemoryInstanceOpts

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:64
Returns number

getUri

getUri(otherDb?: string, otherIp?: string): string

- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:341
Returns an mongodb URI that is setup with all replSet servers

throws

if state is not "running"

throws

if an server doesnt have "instanceInfo.port" defined

Parameters
- Optional otherDb: string
  
  add an database into the uri (in mongodb its the auth database, in mongoose its the default database for models)
- Optional otherIp: string
  
  change the ip in the generated uri, default will otherwise always be "127.0.0.1"
Returns string

an valid mongo URI, by the definition of https://docs.mongodb.com/manual/reference/connection-string/

Protected initAllServers

initAllServers(): Promise<void>

- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:409
Initialize & start all servers in the replSet

Returns Promise<void>

listenerCount

listenerCount(event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): MongoMemoryReplSet

Inherited from EventEmitter.off
- Defined in node_modules/@types/node/events.d.ts:61
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns MongoMemoryReplSet

on

on(event: stateChange, listener: (...args: any[]) => void): MongoMemoryReplSet

Overrides EventEmitter.on
- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:143
Parameters
- event: stateChange
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns MongoMemoryReplSet

once

once(event: stateChange, listener: (...args: any[]) => void): MongoMemoryReplSet

Overrides EventEmitter.once
- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:144
Parameters
- event: stateChange
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns MongoMemoryReplSet

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): MongoMemoryReplSet

Inherited from EventEmitter.prependListener
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns MongoMemoryReplSet

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): MongoMemoryReplSet

Inherited from EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns MongoMemoryReplSet

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners
- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): MongoMemoryReplSet

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- Optional event: string | symbol
Returns MongoMemoryReplSet

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): MongoMemoryReplSet

Inherited from EventEmitter.removeListener
- Defined in node_modules/@types/node/events.d.ts:60
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns MongoMemoryReplSet

setMaxListeners

setMaxListeners(n: number): MongoMemoryReplSet

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:63
Parameters
- n: number
Returns MongoMemoryReplSet

start

start(): Promise<void>

- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:374
Start underlying mongod instances.

throws

if state is already "running"

Returns Promise<void>

Protected stateChange

stateChange(newState: MongoMemoryReplSetStates, ...args: any[]): void

- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:181
Change "this._state" to "newState" and emit "newState"

Parameters
- newState: MongoMemoryReplSetStates
  
  The new State to set & emit
- Rest ...args: any[]
Returns void

stop

stop(runCleanup: boolean): Promise<boolean>
stop(cleanupOptions?: Cleanup): Promise<boolean>

- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:512
Stop the underlying mongod instance(s).

deprecated

replace argument with Cleanup interface object

Parameters
- runCleanup: boolean
  
  run "this.cleanup"? (remove dbPath & reset "instanceInfo")
Returns Promise<boolean>
- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:517
Stop the underlying mongod instance(s).

Parameters
- Optional cleanupOptions: Cleanup
  
  Set how to run ".cleanup", by default only { doCleanup: true } is used
Returns Promise<boolean>

waitUntilRunning

waitUntilRunning(): Promise<void>

- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:629
Wait until all instances are running

throws

if state is "stopped" (cannot wait on something that dosnt start)

Returns Promise<void>

Static create

create(opts?: Partial<MongoMemoryReplSetOpts>): Promise<MongoMemoryReplSet>

- Defined in packages/mongodb-memory-server-core/src/MongoMemoryReplSet.ts:190
Create an instance of "MongoMemoryReplSet" and call start

Parameters
- Optional opts: Partial<MongoMemoryReplSetOpts>
  
  Options for the ReplSet
Returns Promise<MongoMemoryReplSet>

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:26
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

Inherited from EventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:23
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>

Static once

once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
once(emitter: DOMEventTarget, event: string): Promise<any[]>

Inherited from EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:21
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:22
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

opts: Partial<MongoMemoryReplSetOpts> = {}

Returns MongoMemoryReplSet

Properties

Protected _binaryOpts

Protected _instanceOpts

Protected Optional _keyfiletmp

Protected _ranCreateAuth

Protected _replSetOpts

Protected _state

servers

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Accessors

binaryOpts

Returns MongoBinaryOpts

Parameters

val: MongoBinaryOpts

Returns void

instanceOpts

Returns MongoMemoryInstanceOptsBase[]

Parameters

val: MongoMemoryInstanceOptsBase[]

Returns void

replSetOpts

Returns ReplSetOpts

Parameters

val: ReplSetOpts

Returns void

state

Returns MongoMemoryReplSetStates

Methods

Protected _initReplSet

Returns Promise<void>

Protected _initServer

Parameters

instanceOpts: MongoMemoryInstanceOpts

Returns MongoMemoryServer

Protected _waitForPrimary

Parameters

timeout: number = ...

Optional where: string

Returns Promise<void>

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns MongoMemoryReplSet

cleanup

Parameters

force: boolean

Returns Promise<void>

Parameters

Optional options: Cleanup

Returns Promise<void>

emit

Parameters

event: stateChange

Rest ...args: any[]

Returns boolean

Protected enableAuth

Returns boolean

Protected ensureKeyFile

Returns Promise<string>

eventNames

Returns (string | symbol)[]