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

id, title

id	title
mongo-instance	MongoInstance

API Documentation of MongoInstance-Class

Functions

new

Typings: constructor(opts: Partial<MongodOpts>)

Create an new Instance without starting it

:::tip When directly starting the instance, run should be used :::

debug

Typings: private debug(msg: string): void

Format input with debug-message template

create

Typings: static async create(opts: Partial<MongodOpts>): Promise<MongoInstance>

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

prepareCommandArgs

Typings: prepareCommandArgs(): string[]

Constructs the Command Arguments

start

Typings: async start(): Promise<void>

Start the mongod and the watcher processes

:::warning Currently does not check if the instance is in a correct state and just resets all values, see #662. :::

stop

Typings: async stop(): Promise<boolean>

Stop the mongod and the watcher processes

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

_launchMongod

Internal

Typings: _launchMongod(mongoBin: string): ChildProcess

Actually spawn the mongod process with ChildProcess, used by run

_launchKiller

Internal

Typings: _launchKiller(parentPid: number, childPid: number): ChildProcess

Spawn an killer process that keeps watch over the mongod process

errorHandler

Internal

Typings: errorHandler(err: string): void

Error handler for the mongod process

closeHandler

Internal

Typings: closeHandler(code: number, signal: string): void

Close handler for the mongod process

stderrHandler

Internal

Typings: stderrHandler(message: string | Buffer): void

STDERR handler for the mongod process

stdoutHandler

Internal

Typings: stdoutHandler(message: string | Buffer): void

STDOUT handler for the mongod process
Matches process output against known formats and raise events

Values

instanceOpts

Typings: instanceOpts: MongoInstanceOpts

Stores the Instance Options

binaryOpts

Typings: readonly binaryOpts: Readonly<MongoBinaryOpts>

Stores the Binary Options

spawnOpts

Typings: readonly spawnOpts: Readonly<SpawnOptions>

Stores the Spawn Options

extraConnectionOptions

Internal

Typings: extraConnectionOptions?: MongoClientOptions

Contains extra Connection options used for mongoClient.connect, this is mainly used for authentication

mongodProcess

Internal

Typings: mongodProcess?: ChildProcess

Stores the active process reference for the mongod process

killerProcess

Internal

Typings: killerProcess?: ChildProcess

Stores the active process reference for the killer process

isInstancePrimary

Typings: isInstancePrimary: boolean

Stores that the process is an Primary (ReplSet) (event emitted when found in STDOUT)

isInstanceReady

Typings: isInstanceReady: boolean (event emitted when found in STDOUT)

Stores that the process is fully started

isReplSet

Typings: isReplSet: boolean

Stores that the process is in an ReplSet, is true when instanceOpts.replSet is defined and truthy