MongoClient | mongodb

The MongoClient class is a class that allows for making Connections to MongoDB.

remarks

The programmatically provided options take precedence over the URI options.

example

// Connect using a MongoClient instance
const MongoClient = require('mongodb').MongoClient;
const test = require('assert');
// Connection url
const url = 'mongodb://localhost:27017';
// Database Name
const dbName = 'test';
// Connect using MongoClient
const mongoClient = new MongoClient(url);
mongoClient.connect(function(err, client) {
  const db = client.db(dbName);
  client.close();
});

example

// Connect using the MongoClient.connect static method
const MongoClient = require('mongodb').MongoClient;
const test = require('assert');
// Connection url
const url = 'mongodb://localhost:27017';
// Database Name
const dbName = 'test';
// Connect using MongoClient
MongoClient.connect(url, function(err, client) {
  const db = client.db(dbName);
  client.close();
});

Hierarchy

TypedEventEmitter<MongoClientEvents>
- MongoClient

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new MongoClient(url: string, options?: MongoClientOptions): MongoClient

Overrides TypedEventEmitter.constructor
- Defined in src/mongo_client.ts:329
Parameters
- url: string
- Optional options: MongoClientOptions
Returns MongoClient

Properties

[kOptions]

[kOptions]: MongoOptions

The consolidate, parsed, transformed and merged options.

internal

s

s: MongoClientPrivate

internal

Optional topology

topology: Topology

internal

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

autoEncrypter

get autoEncrypter(): undefined | AutoEncrypter

- Defined in src/mongo_client.ts:380
Returns undefined | AutoEncrypter

bsonOptions

get bsonOptions(): BSONSerializeOptions

- Defined in src/mongo_client.ts:396
Returns BSONSerializeOptions

logger

get logger(): Logger

- Defined in src/mongo_client.ts:400
Returns Logger

monitorCommands

get monitorCommands(): boolean
set monitorCommands(value: boolean): void

- Defined in src/mongo_client.ts:373
Intended for APM use only

internal

Returns boolean
- Defined in src/mongo_client.ts:376
Intended for APM use only

Parameters
- value: boolean
Returns void

options

get options(): Readonly<MongoOptions>

- Defined in src/mongo_client.ts:362
Returns Readonly<MongoOptions>

readConcern

get readConcern(): undefined | ReadConcern

- Defined in src/mongo_client.ts:384
Returns undefined | ReadConcern

readPreference

get readPreference(): ReadPreference

- Defined in src/mongo_client.ts:392
Returns ReadPreference

serverApi

get serverApi(): Readonly<undefined | ServerApi>

- Defined in src/mongo_client.ts:366
Returns Readonly<undefined | ServerApi>

writeConcern

get writeConcern(): undefined | WriteConcern

- Defined in src/mongo_client.ts:388
Returns undefined | WriteConcern

Methods

addListener

addListener<EventKey>(event: EventKey, listener: MongoClientEvents[EventKey]): MongoClient
addListener(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): MongoClient
addListener(event: string | symbol, listener: GenericListener): MongoClient

Inherited from TypedEventEmitter.addListener
- Defined in src/mongo_types.ts:341
Type parameters
- EventKey: "close" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
Parameters
- event: EventKey
- listener: MongoClientEvents[EventKey]
Returns MongoClient
Inherited from TypedEventEmitter.addListener
- Defined in src/mongo_types.ts:342
Parameters
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns MongoClient
Inherited from TypedEventEmitter.addListener
- Defined in src/mongo_types.ts:346
Parameters
- event: string | symbol
- listener: GenericListener
Returns MongoClient

close

close(): Promise<void>
close(callback: Callback<void>): void
close(force: boolean): Promise<void>
close(force: boolean, callback: Callback<void>): void

- Defined in src/mongo_client.ts:430
Close the db and its underlying connections

Returns Promise<void>
- Defined in src/mongo_client.ts:431
Parameters
- callback: Callback<void>
Returns void
- Defined in src/mongo_client.ts:432
Parameters
- force: boolean
Returns Promise<void>
- Defined in src/mongo_client.ts:433
Parameters
- force: boolean
- callback: Callback<void>
Returns void

connect

connect(): Promise<MongoClient>
connect(callback: Callback<MongoClient>): void

- Defined in src/mongo_client.ts:409
Connect to MongoDB using a url

see

docs.mongodb.org/manual/reference/connection-string/

Returns Promise<MongoClient>
- Defined in src/mongo_client.ts:410
Parameters
- callback: Callback<MongoClient>
Returns void

db

db(dbName?: string, options?: DbOptions): Db

- Defined in src/mongo_client.ts:472
Create a new Db instance sharing the current socket connections.

Parameters
- Optional dbName: string
  
  The name of the database we want to use. If not provided, use database name from connection string.
- Optional options: DbOptions
  
  Optional settings for Db construction
Returns Db

emit

emit<EventKey>(event: symbol | EventKey, ...args: Parameters<MongoClientEvents[EventKey]>): boolean

Inherited from TypedEventEmitter.emit
- Defined in src/mongo_types.ts:388
Type parameters
- EventKey: "close" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
Parameters
- event: symbol | EventKey
- Rest ...args: Parameters<MongoClientEvents[EventKey]>
Returns boolean

eventNames

eventNames(): string[]

Inherited from TypedEventEmitter.eventNames
- Defined in src/mongo_types.ts:414
Returns string[]

getLogger

getLogger(): Logger

- Defined in src/mongo_client.ts:614
Return the mongo client logger

Returns Logger

getMaxListeners

getMaxListeners(): number

Inherited from TypedEventEmitter.getMaxListeners
- Defined in src/mongo_types.ts:415
Returns number

listenerCount

listenerCount<EventKey>(type: string | symbol | EventKey): number

Inherited from TypedEventEmitter.listenerCount
- Defined in src/mongo_types.ts:393
Type parameters
- EventKey: "close" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
Parameters
- type: string | symbol | EventKey
Returns number

listeners

listeners<EventKey>(event: string | symbol | EventKey): MongoClientEvents[EventKey][]

Inherited from TypedEventEmitter.listeners
- Defined in src/mongo_types.ts:380
Type parameters
- EventKey: "close" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
Parameters
- event: string | symbol | EventKey
Returns MongoClientEvents[EventKey][]

off

off<EventKey>(event: EventKey, listener: MongoClientEvents[EventKey]): MongoClient
off(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): MongoClient
off(event: string | symbol, listener: GenericListener): MongoClient

Inherited from TypedEventEmitter.off
- Defined in src/mongo_types.ts:369
Type parameters
- EventKey: "close" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
Parameters
- event: EventKey
- listener: MongoClientEvents[EventKey]
Returns MongoClient
Inherited from TypedEventEmitter.off
- Defined in src/mongo_types.ts:370
Parameters
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns MongoClient
Inherited from TypedEventEmitter.off
- Defined in src/mongo_types.ts:374
Parameters
- event: string | symbol
- listener: GenericListener
Returns MongoClient

on

on<EventKey>(event: EventKey, listener: MongoClientEvents[EventKey]): MongoClient
on(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): MongoClient
on(event: string | symbol, listener: GenericListener): MongoClient

Inherited from TypedEventEmitter.on
- Defined in src/mongo_types.ts:348
Type parameters
- EventKey: "close" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
Parameters
- event: EventKey
- listener: MongoClientEvents[EventKey]
Returns MongoClient
Inherited from TypedEventEmitter.on
- Defined in src/mongo_types.ts:349
Parameters
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns MongoClient
Inherited from TypedEventEmitter.on
- Defined in src/mongo_types.ts:353
Parameters
- event: string | symbol
- listener: GenericListener
Returns MongoClient

once

once<EventKey>(event: EventKey, listener: MongoClientEvents[EventKey]): MongoClient
once(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): MongoClient
once(event: string | symbol, listener: GenericListener): MongoClient

Inherited from TypedEventEmitter.once
- Defined in src/mongo_types.ts:355
Type parameters
- EventKey: "close" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
Parameters
- event: EventKey
- listener: MongoClientEvents[EventKey]
Returns MongoClient
Inherited from TypedEventEmitter.once
- Defined in src/mongo_types.ts:356
Parameters
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns MongoClient
Inherited from TypedEventEmitter.once
- Defined in src/mongo_types.ts:360
Parameters
- event: string | symbol
- listener: GenericListener
Returns MongoClient

prependListener

prependListener<EventKey>(event: EventKey, listener: MongoClientEvents[EventKey]): MongoClient
prependListener(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): MongoClient
prependListener(event: string | symbol, listener: GenericListener): MongoClient

Inherited from TypedEventEmitter.prependListener
- Defined in src/mongo_types.ts:397
Type parameters
- EventKey: "close" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
Parameters
- event: EventKey
- listener: MongoClientEvents[EventKey]
Returns MongoClient
Inherited from TypedEventEmitter.prependListener
- Defined in src/mongo_types.ts:398
Parameters
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns MongoClient
Inherited from TypedEventEmitter.prependListener
- Defined in src/mongo_types.ts:402
Parameters
- event: string | symbol
- listener: GenericListener
Returns MongoClient

prependOnceListener

prependOnceListener<EventKey>(event: EventKey, listener: MongoClientEvents[EventKey]): MongoClient
prependOnceListener(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): MongoClient
prependOnceListener(event: string | symbol, listener: GenericListener): MongoClient

Inherited from TypedEventEmitter.prependOnceListener
- Defined in src/mongo_types.ts:404
Type parameters
- EventKey: "close" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
Parameters
- event: EventKey
- listener: MongoClientEvents[EventKey]
Returns MongoClient
Inherited from TypedEventEmitter.prependOnceListener
- Defined in src/mongo_types.ts:408
Parameters
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns MongoClient
Inherited from TypedEventEmitter.prependOnceListener
- Defined in src/mongo_types.ts:412
Parameters
- event: string | symbol
- listener: GenericListener
Returns MongoClient

rawListeners

rawListeners<EventKey>(event: string | symbol | EventKey): MongoClientEvents[EventKey][]

Inherited from TypedEventEmitter.rawListeners
- Defined in src/mongo_types.ts:384
Type parameters
- EventKey: "close" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
Parameters
- event: string | symbol | EventKey
Returns MongoClientEvents[EventKey][]

removeAllListeners

removeAllListeners<EventKey>(event?: string | symbol | EventKey): MongoClient

Inherited from TypedEventEmitter.removeAllListeners
- Defined in src/mongo_types.ts:376
Type parameters
- EventKey: "close" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
Parameters
- Optional event: string | symbol | EventKey
Returns MongoClient

removeListener

removeListener<EventKey>(event: EventKey, listener: MongoClientEvents[EventKey]): MongoClient
removeListener(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): MongoClient
removeListener(event: string | symbol, listener: GenericListener): MongoClient

Inherited from TypedEventEmitter.removeListener
- Defined in src/mongo_types.ts:362
Type parameters
- EventKey: "close" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
Parameters
- event: EventKey
- listener: MongoClientEvents[EventKey]
Returns MongoClient
Inherited from TypedEventEmitter.removeListener
- Defined in src/mongo_types.ts:363
Parameters
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns MongoClient
Inherited from TypedEventEmitter.removeListener
- Defined in src/mongo_types.ts:367
Parameters
- event: string | symbol
- listener: GenericListener
Returns MongoClient

setMaxListeners

setMaxListeners(n: number): MongoClient

Inherited from TypedEventEmitter.setMaxListeners
- Defined in src/mongo_types.ts:416
Parameters
- n: number
Returns MongoClient

startSession

startSession(): ClientSession
startSession(options: ClientSessionOptions): ClientSession

- Defined in src/mongo_client.ts:526
Starts a new session on the server

Returns ClientSession
- Defined in src/mongo_client.ts:527
Parameters
- options: ClientSessionOptions
Returns ClientSession

watch

watch<TSchema>(pipeline?: Document[], options?: ChangeStreamOptions): ChangeStream<TSchema>

- Defined in src/mongo_client.ts:600
Create a new Change Stream, watching for new changes (insertions, updates, replacements, deletions, and invalidations) in this cluster. Will ignore all changes to system collections, as well as the local, admin, and config databases.

Type parameters
- TSchema = Document
Parameters
- pipeline: Document[] = []
  
  An array of aggregation pipeline stages through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents.
- options: ChangeStreamOptions = {}
  
  Optional settings for the command
Returns ChangeStream<TSchema>

withSession

withSession(callback: WithSessionCallback): Promise<void>
withSession(options: ClientSessionOptions, callback: WithSessionCallback): Promise<void>

- Defined in src/mongo_client.ts:546
Runs a given operation with an implicitly created session. The lifetime of the session will be handled without the need for user interaction.

NOTE: presently the operation MUST return a Promise (either explicit or implicitly as an async function)

Parameters
- callback: WithSessionCallback
  
  An callback to execute with an implicitly created session
Returns Promise<void>
- Defined in src/mongo_client.ts:547
Parameters
- options: ClientSessionOptions
- callback: WithSessionCallback
Returns Promise<void>

Static connect

connect(url: string): Promise<MongoClient>
connect(url: string, callback: Callback<MongoClient>): void
connect(url: string, options: MongoClientOptions): Promise<MongoClient>
connect(url: string, options: MongoClientOptions, callback: Callback<MongoClient>): void

- Defined in src/mongo_client.ts:498
Connect to MongoDB using a url

remarks

The programmatically provided options take precedence over the URI options.

see

https://www.mongodb.com/docs/manual/reference/connection-string/

Parameters
- url: string
Returns Promise<MongoClient>
- Defined in src/mongo_client.ts:499
Parameters
- url: string
- callback: Callback<MongoClient>
Returns void
- Defined in src/mongo_client.ts:500
Parameters
- url: string
- options: MongoClientOptions
Returns Promise<MongoClient>
- Defined in src/mongo_client.ts:501
Parameters
- url: string
- options: MongoClientOptions
- callback: Callback<MongoClient>
Returns void

Static getEventListener

getEventListener(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]

Inherited from TypedEventEmitter.getEventListener
- Defined in node_modules/@types/node/events.d.ts:34
Returns a list listener for a specific emitter event name.

Parameters
- emitter: DOMEventTarget | EventEmitter
- name: string | symbol
Returns Function[]

Static listenerCount

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

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

since v4.0.0

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

Static on

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

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

Static once

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

Inherited from TypedEventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:25
Parameters
- emitter: NodeEventTarget
- event: string | symbol
- Optional options: StaticEventEmitterOptions
Returns Promise<any[]>
Inherited from TypedEventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- emitter: DOMEventTarget
- event: string
- Optional options: StaticEventEmitterOptions
Returns Promise<any[]>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

url: string

Optional options: MongoClientOptions

Returns MongoClient

Properties

[kOptions]

s

Optional topology

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Accessors

autoEncrypter

Returns undefined | AutoEncrypter

bsonOptions

Returns BSONSerializeOptions

logger

Returns Logger

monitorCommands

Returns boolean

Parameters

value: boolean

Returns void

options

Returns Readonly<MongoOptions>

readConcern

Returns undefined | ReadConcern

readPreference

Returns ReadPreference

serverApi

Returns Readonly<undefined | ServerApi>

writeConcern

Returns undefined | WriteConcern

Methods

addListener

Type parameters

Parameters

event: EventKey

listener: MongoClientEvents[EventKey]

Returns MongoClient

Parameters

event: CommonEvents

listener: (eventName: string | symbol, listener: GenericListener) => void

Parameters

eventName: string | symbol

listener: GenericListener

Returns void

Returns MongoClient

Parameters

event: string | symbol

listener: GenericListener

Returns MongoClient

close

Returns Promise<void>

Parameters

callback: Callback<void>

Returns void

Parameters

force: boolean

Returns Promise<void>

Parameters

force: boolean

callback: Callback<void>

Returns void

connect

Returns Promise<MongoClient>

Parameters

callback: Callback<MongoClient>

Returns void

db

Parameters