mongodb-memory-server/docs/api/classes/mongo-memory-replset.md

id, title

id	title
mongo-memory-replset	MongoMemoryReplSet

API Documentation of MongoMemoryReplSet-Class

Functions

new

Typings: constructor(opts: Partial<MongoMemoryReplSetOpts> = {})

Create an new ReplSet without starting it

:::tip When directly starting the replset, create should be used :::

create

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

Create an new ReplSet and start it (while being an Promise)

stateChange

Internal

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

Used to change the state of the class, it is protected to not accidentally use it

getInstanceOpts

Internal

Typings: protected getInstanceOpts(baseOpts: MongoMemoryInstancePropBase = {}): MongoMemoryInstanceProp

Constructs the options used for an instance

getUri

Typings: getUri(otherDb?: string): string

Get an mongodb-usable uri (can also be used in mongoose)

start

Typings: async start(): Promise<void>

Used to start an new ReplSet or to Re-Start an stopped ReplSet

:::caution Will Error if ReplSet is already running :::

initAllServers

Internal

Typings: protected async initAllServers(): Promise<void>

Used by start and to restart without fully running everything again

ensureKeyFile

Internal

Typings: protected async ensureKeyFile(): Promise<tmp.DirResult>

Ensures and returns that _keyfiletmp is defined an exists and also that the keyfile is created

stop

Typings: async stop(runCleanup: boolean = true): Promise<boolean>

Stop an running instance

This function will by default run .cleanup, this must be set to false to be able to restart (and an engine other than ephemeralForTest must be used)

:::caution Will not Error if instance is not running :::

cleanup

Typings: async cleanup(force: boolean = false): Promise<void>

Cleanup all files used by this ReplSet & instances

:::tip Runs automatically on process.on('beforeExit') :::

waitUntilRunning

Typings: async waitUntilRunning(): Promise<void>

Wait until all instances are running

_initReplSet

Internal

Typings: protected async _initReplSet(): Promise<void>

This is used to connect to the first server and initiate the ReplSet with an command
Also enables auth

_initServer

Internal

Typings: protected _initServer(instanceOpts: MongoMemoryInstanceProp): MongoMemoryServer

Creates an new instance for the ReplSet

_waitForPrimary

Internal

Typings: protected async _waitForPrimary(timeout: number = 1000 * 30, where?: string): Promise<void>

Wait until the ReplSet has elected an Primary, the where string will be added to the error if the timeout is reached

Values

servers

Typings: servers: MongoMemoryServer[]

Stores all the servers of this ReplSet

instanceOpts

Typings:

• get instanceOpts(): MongoMemoryInstancePropBase[]
• set instanceOpts(val: MongoMemoryInstancePropBase[])

Getter & Setter for _instanceOpts

:::caution Will Throw an Error if state is not stopped :::

_instanceOpts

Internal

Typings: protected _instanceOpts!: MongoMemoryInstancePropBase[]

Stores Options used for an instance

binaryOpts

Typings:

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

Getter & Setter for _binaryOpts

:::caution Will Throw an Error if state is not stopped :::

_binaryOpts

Internal

Typings: protected _binaryOpts!: MongoBinaryOpts

Stores the options used for the binary

replSetOpts

Typings:

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

Getter & Setter for _replSetOpts

:::caution Will Throw an Error if state is not stopped :::

_replSetOpts

Internal

Typings: protected _replSetOpts!: Required<ReplSetOpts>

Stores the options used for the ReplSet Initiation

_keyfiletmp

Internal

Typings: protected _keyfiletmp?: tmp.DirResult

Stores the tmpDir for the keyfile location

state

Typings: get state(): MongoMemoryReplSetStates

Getter for _state

:::caution Will Throw an Error if state is not stopped :::

_state

Internal

Typings: protected _state: MongoMemoryReplSetStates

Stores the current State

_ranCreateAuth

Internal

Typings: protected _ranCreateAuth: boolean

Stores if the auth creation has already ran