Class MongoInstance

MongoDB Instance Handler Class This Class starts & stops the "mongod" process directly and handles stdout, sterr and close events

Hierarchy

EventEmitter
- MongoInstance

Implements

ManagerBase

Constructors

constructor

new MongoInstance(opts): MongoInstance
Parameters
- opts: Partial<MongodOpts>
Returns MongoInstance
Inherited from EventEmitter.constructor
- Defined in packages/mongodb-memory-server-core/src/util/MongoInstance.ts:256

Properties

`Readonly` binaryOpts

binaryOpts: Readonly<MongoBinaryOpts>

`Optional` extraConnectionOptions

extraConnectionOptions?: MongoClientOptions

Extra options to append to "mongoclient.connect" Mainly used for authentication

instanceOpts

instanceOpts: MongoMemoryInstanceOpts

isInstancePrimary

isInstancePrimary: boolean = false

This boolean is "true" if the instance is elected to be PRIMARY

isInstanceReady

isInstanceReady: boolean = false

This boolean is "true" if the instance is successfully started

isReplSet

isReplSet: boolean = false

This boolean is "true" if the instance is part of an replset

`Optional` killerProcess

killerProcess?: ChildProcess

The "mongo_killer" Process reference

`Optional` mongodProcess

mongodProcess?: ChildProcess

The "mongod" Process reference

`Readonly` spawnOpts

spawnOpts: Readonly<SpawnOptions>

`Optional` stopPromise

stopPromise?: Promise<boolean>

Extra promise to avoid multiple calls of .stop at the same time

See

https://github.com/typegoose/mongodb-memory-server/issues/802

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

Methods

_launchKiller

_launchKiller(parentPid, childPid): ChildProcess
Spawn an seperate process to kill the parent and the mongod instance to ensure "mongod" gets stopped in any case
Parameters
- parentPid: number
  
  Parent nodejs process
- childPid: number
  
  Mongod process to kill
Returns ChildProcess

Fires
MongoInstance#killerLaunched
- Defined in packages/mongodb-memory-server-core/src/util/MongoInstance.ts:530

_launchMongod

_launchMongod(mongoBin): ChildProcess
Actually launch mongod
Parameters
- mongoBin: string
  
  The binary to run
Returns ChildProcess

Fires
MongoInstance#instanceLaunched
- Defined in packages/mongodb-memory-server-core/src/util/MongoInstance.ts:502

addListener

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

`Protected` checkErrorInLine

checkErrorInLine(line): void
Run Checks on the line if the lines contain any thrown errors
Parameters
- line: string
  
  The Line to check
Returns void
- Defined in packages/mongodb-memory-server-core/src/util/MongoInstance.ts:639

closeHandler

closeHandler(code, signal): void
Write the CLOSE event to the debug function
Parameters
- code: null | number
  
  The Exit code to handle
- signal: null | string
  
  The Signal to handle
Returns void

Fires
MongoInstance#instanceClosed
- Defined in packages/mongodb-memory-server-core/src/util/MongoInstance.ts:568

`Protected` debug

debug(msg, ...extra): void
Debug-log with template applied
Parameters
- msg: string
  
  The Message to log
- Rest ...extra: unknown[]
Returns void
- Defined in packages/mongodb-memory-server-core/src/util/MongoInstance.ts:280

emit

emit(event, ...args): boolean
Parameters
- event: MongoInstanceEvents
- Rest ...args: any[]
Returns boolean
Overrides EventEmitter.emit
- Defined in packages/mongodb-memory-server-core/src/util/MongoInstance.ts:205

errorHandler

errorHandler(err): void
Event "error" handler
Parameters
- err: string
  
  The Error to handle
Returns void

Fires
MongoInstance#instanceRawError

Fires
MongoInstance#instanceError
- Defined in packages/mongodb-memory-server-core/src/util/MongoInstance.ts:557

eventNames

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

getMaxListeners

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

listenerCount

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

listeners

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

off

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

on

on(event, listener): MongoInstance
Parameters
- event: MongoInstanceEvents
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns MongoInstance
Overrides EventEmitter.on
- Defined in packages/mongodb-memory-server-core/src/util/MongoInstance.ts:206

once

once(event, listener): MongoInstance
Parameters
- event: MongoInstanceEvents
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns MongoInstance
Overrides EventEmitter.once
- Defined in packages/mongodb-memory-server-core/src/util/MongoInstance.ts:207

prepareCommandArgs

prepareCommandArgs(): string[]
Create an array of arguments for the mongod instance

Returns string[]
- Defined in packages/mongodb-memory-server-core/src/util/MongoInstance.ts:300

prependListener

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

prependOnceListener

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

rawListeners

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

removeAllListeners

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

removeListener

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

setMaxListeners

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

start

start(): Promise<void>
Create the mongod process

Returns Promise<void>

Fires
MongoInstance#instanceStarted
- Defined in packages/mongodb-memory-server-core/src/util/MongoInstance.ts:349

stderrHandler

stderrHandler(message): void
Write STDERR to debug function
Parameters
- message: string | Buffer
  
  The STDERR line to write
Returns void

Fires
MongoInstance#instanceSTDERR
- Defined in packages/mongodb-memory-server-core/src/util/MongoInstance.ts:590

stdoutHandler

stdoutHandler(message): void
Write STDOUT to debug function and process some special messages
Parameters
- message: string | Buffer
  
  The STDOUT line to write/parse
Returns void

Fires
MongoInstance#instanceSTDOUT

Fires
MongoInstance#instanceReady

Fires
MongoInstance#instanceError

Fires
MongoInstance#instancePrimary

Fires
MongoInstance#instanceReplState
- Defined in packages/mongodb-memory-server-core/src/util/MongoInstance.ts:607

stop

stop(): Promise<boolean>
Shutdown all related processes (Mongod Instance & Killer Process)

Returns Promise<boolean>
- Defined in packages/mongodb-memory-server-core/src/util/MongoInstance.ts:409

`Static` create

create(opts): Promise<MongoInstance>
Create an new instance an call method "start"
Parameters
- opts: Partial<MongodOpts>
  
  Options passed to the new instance
Returns Promise<MongoInstance>
- Defined in packages/mongodb-memory-server-core/src/util/MongoInstance.ts:289

`Static` listenerCount

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

Deprecated
since v4.0.0
Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:26

`Static` on

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

`Static` once

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

Class MongoInstance

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

opts: Partial<MongodOpts>

Returns MongoInstance

Properties

Readonly binaryOpts

Optional extraConnectionOptions

instanceOpts

isInstancePrimary

isInstanceReady

isReplSet

Optional killerProcess

Optional mongodProcess

Readonly spawnOpts

Optional stopPromise

See

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

_launchKiller

Parameters

parentPid: number

childPid: number

Returns ChildProcess

Fires

_launchMongod

Parameters

mongoBin: string

Returns ChildProcess

Fires

addListener

Parameters

event: string | symbol

listener: ((...args) => void)

Parameters

Rest ...args: any[]

Returns void

Returns MongoInstance

Protected checkErrorInLine

Parameters

line: string

Returns void

closeHandler

Parameters

code: null | number

signal: null | string

Returns void

Fires

Protected debug

Parameters

msg: string

Rest ...extra: unknown[]

Returns void

emit

Parameters

event: MongoInstanceEvents

Rest ...args: any[]

Returns boolean

errorHandler

Parameters

err: string

Returns void

Fires

Fires

eventNames

Returns (string | symbol)[]

getMaxListeners

Returns number

listenerCount

Parameters

`Readonly` binaryOpts

`Optional` extraConnectionOptions

`Optional` killerProcess

`Optional` mongodProcess

`Readonly` spawnOpts

`Optional` stopPromise

`Static` `Readonly` captureRejectionSymbol

`Static` captureRejections

`Static` defaultMaxListeners

`Static` `Readonly` errorMonitor

`Rest` ...args: any[]

`Protected` checkErrorInLine

`Protected` debug

`Rest` ...extra: unknown[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Optional` event: string | symbol

`Rest` ...args: any[]