MongoClient | Documentation

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

import { MongoClient } from 'mongodb';

// Enable command monitoring for debugging
const client = new MongoClient('mongodb://localhost:27017', { monitorCommands: true });

client.on('commandStarted', started => console.log(started));
client.db().collection('pets');
await client.insertOne({ name: 'spot', kind: 'dog' });

Hierarchy

TypedEventEmitter<MongoClientEvents>
- MongoClient

Methods

Static once

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

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

Static on

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

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

Static listenerCount

listenerCount(emitter: <internal>.EventEmitter, event: string | symbol): number

Inherited from TypedEventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:18
deprecated
since v4.0.0

Parameters
- emitter: <internal>.EventEmitter
- event: string | symbol
Returns number

connect

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

- Defined in node_modules/mongodb/mongodb.d.ts:4700
Connect to MongoDB using a url

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

Returns Promise<MongoClient>
- Defined in node_modules/mongodb/mongodb.d.ts:4702
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- callback: <internal>.Callback<MongoClient>
Returns void

close

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

- Defined in node_modules/mongodb/mongodb.d.ts:4709
Close the db and its underlying connections

Returns Promise<void>
- Defined in node_modules/mongodb/mongodb.d.ts:4710
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- force: boolean
Returns Promise<void>
- Defined in node_modules/mongodb/mongodb.d.ts:4712
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- callback: <internal>.Callback<void>
Returns void
- Defined in node_modules/mongodb/mongodb.d.ts:4714
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- force: boolean
- callback: <internal>.Callback<void>
Returns void

db

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

- Defined in node_modules/mongodb/mongodb.d.ts:4721
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

Static connect

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

- Defined in node_modules/mongodb/mongodb.d.ts:4730
Connect to MongoDB using a url

remarks
The programmatically provided options take precedence over the URI options.

see
https://docs.mongodb.org/manual/reference/connection-string/

Parameters
- url: string
Returns Promise<MongoClient>
- Defined in node_modules/mongodb/mongodb.d.ts:4731
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- url: string
- options: MongoClientOptions
Returns Promise<MongoClient>
- Defined in node_modules/mongodb/mongodb.d.ts:4733
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- url: string
- callback: <internal>.Callback<MongoClient>
Returns void
- Defined in node_modules/mongodb/mongodb.d.ts:4735
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- url: string
- options: MongoClientOptions
- callback: <internal>.Callback<MongoClient>
Returns void

startSession

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

- Defined in node_modules/mongodb/mongodb.d.ts:4737
Starts a new session on the server

Returns ClientSession
- Defined in node_modules/mongodb/mongodb.d.ts:4738
Parameters
- options: ClientSessionOptions
Returns ClientSession

withSession

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

- Defined in node_modules/mongodb/mongodb.d.ts:4748
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 node_modules/mongodb/mongodb.d.ts:4749
Parameters
- options: ClientSessionOptions
- callback: WithSessionCallback
Returns Promise<void>

watch

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

- Defined in node_modules/mongodb/mongodb.d.ts:4765
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.
remarks
watch() accepts two generic arguments for distinct use cases:
- The first is to provide the schema that may be defined for all the data within the current cluster
- The second is to override the shape of the change stream document entirely, if it is not provided the type will default to ChangeStreamDocument of the first argument
Type Parameters
- TSchema extends <internal>.Document = <internal>.Document
  
  Type of the data being detected by the change stream
- TChange extends <internal>.Document = ChangeStreamDocument<TSchema>
  
  Type of the whole change stream document emitted
Parameters
- Optional pipeline: <internal>.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.
- Optional options: ChangeStreamOptions
  
  Optional settings for the command
Returns ChangeStream<TSchema, TChange>

getLogger

getLogger(): Logger

- Defined in node_modules/mongodb/mongodb.d.ts:4767
Return the mongo client logger

Returns Logger

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 node_modules/mongodb/mongodb.d.ts:6481
Type Parameters
- EventKey extends "error" | "timeout" | "close" | "open" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolReady" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged"
Parameters
- event: EventKey
- listener: MongoClientEvents[EventKey]
Returns MongoClient
Inherited from TypedEventEmitter.addListener
- Defined in node_modules/mongodb/mongodb.d.ts:6482
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 node_modules/mongodb/mongodb.d.ts:6483
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 node_modules/mongodb/mongodb.d.ts:6484
Type Parameters
- EventKey extends "error" | "timeout" | "close" | "open" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolReady" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged"
Parameters
- event: EventKey
- listener: MongoClientEvents[EventKey]
Returns MongoClient
Inherited from TypedEventEmitter.on
- Defined in node_modules/mongodb/mongodb.d.ts:6485
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 node_modules/mongodb/mongodb.d.ts:6486
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 node_modules/mongodb/mongodb.d.ts:6487
Type Parameters
- EventKey extends "error" | "timeout" | "close" | "open" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolReady" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged"
Parameters
- event: EventKey
- listener: MongoClientEvents[EventKey]
Returns MongoClient
Inherited from TypedEventEmitter.once
- Defined in node_modules/mongodb/mongodb.d.ts:6488
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 node_modules/mongodb/mongodb.d.ts:6489
Parameters
- event: string | symbol
- listener: GenericListener
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 node_modules/mongodb/mongodb.d.ts:6490
Type Parameters
- EventKey extends "error" | "timeout" | "close" | "open" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolReady" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged"
Parameters
- event: EventKey
- listener: MongoClientEvents[EventKey]
Returns MongoClient
Inherited from TypedEventEmitter.removeListener
- Defined in node_modules/mongodb/mongodb.d.ts:6491
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 node_modules/mongodb/mongodb.d.ts:6492
Parameters
- event: string | symbol
- listener: GenericListener
Returns MongoClient

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 node_modules/mongodb/mongodb.d.ts:6493
Type Parameters
- EventKey extends "error" | "timeout" | "close" | "open" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolReady" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged"
Parameters
- event: EventKey
- listener: MongoClientEvents[EventKey]
Returns MongoClient
Inherited from TypedEventEmitter.off
- Defined in node_modules/mongodb/mongodb.d.ts:6494
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 node_modules/mongodb/mongodb.d.ts:6495
Parameters
- event: string | symbol
- listener: GenericListener
Returns MongoClient

removeAllListeners

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

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

listeners

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

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

rawListeners

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

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

emit

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

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

listenerCount

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

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

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 node_modules/mongodb/mongodb.d.ts:6501
Type Parameters
- EventKey extends "error" | "timeout" | "close" | "open" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolReady" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged"
Parameters
- event: EventKey
- listener: MongoClientEvents[EventKey]
Returns MongoClient
Inherited from TypedEventEmitter.prependListener
- Defined in node_modules/mongodb/mongodb.d.ts:6502
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 node_modules/mongodb/mongodb.d.ts:6503
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 node_modules/mongodb/mongodb.d.ts:6504
Type Parameters
- EventKey extends "error" | "timeout" | "close" | "open" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolReady" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged"
Parameters
- event: EventKey
- listener: MongoClientEvents[EventKey]
Returns MongoClient
Inherited from TypedEventEmitter.prependOnceListener
- Defined in node_modules/mongodb/mongodb.d.ts:6505
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 node_modules/mongodb/mongodb.d.ts:6506
Parameters
- event: string | symbol
- listener: GenericListener
Returns MongoClient

eventNames

eventNames(): string[]

Inherited from TypedEventEmitter.eventNames
- Defined in node_modules/mongodb/mongodb.d.ts:6507
Returns string[]

getMaxListeners

getMaxListeners(): number

Inherited from TypedEventEmitter.getMaxListeners
- Defined in node_modules/mongodb/mongodb.d.ts:6508
Returns number

setMaxListeners

setMaxListeners(n: number): MongoClient

Inherited from TypedEventEmitter.setMaxListeners
- Defined in node_modules/mongodb/mongodb.d.ts:6509
Parameters
- n: number
Returns MongoClient

Properties

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.

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Constructors

constructor

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

Overrides TypedEventEmitter.constructor
- Defined in node_modules/mongodb/mongodb.d.ts:4684
Parameters
- url: string
- Optional options: MongoClientOptions
Returns MongoClient

Accessors

options

get options(): Readonly<<internal>.MongoOptions>

- Defined in node_modules/mongodb/mongodb.d.ts:4685
Returns Readonly<<internal>.MongoOptions>

serverApi

get serverApi(): Readonly<ServerApi>

- Defined in node_modules/mongodb/mongodb.d.ts:4686
Returns Readonly<ServerApi>

autoEncrypter

get autoEncrypter(): AutoEncrypter

- Defined in node_modules/mongodb/mongodb.d.ts:4689
Returns AutoEncrypter

readConcern

get readConcern(): ReadConcern

- Defined in node_modules/mongodb/mongodb.d.ts:4690
Returns ReadConcern

writeConcern

get writeConcern(): WriteConcern

- Defined in node_modules/mongodb/mongodb.d.ts:4691
Returns WriteConcern

readPreference

get readPreference(): ReadPreference

- Defined in node_modules/mongodb/mongodb.d.ts:4692
Returns ReadPreference

bsonOptions

get bsonOptions(): BSONSerializeOptions

- Defined in node_modules/mongodb/mongodb.d.ts:4693
Returns BSONSerializeOptions

logger

get logger(): Logger

- Defined in node_modules/mongodb/mongodb.d.ts:4694
Returns Logger

Hierarchy

Index

Methods

Properties

Constructors

Accessors

Methods

Static once

Parameters

emitter: <internal>.NodeEventTarget

event: string | symbol

Returns Promise<any[]>

Parameters

emitter: <internal>.DOMEventTarget

event: string

Returns Promise<any[]>

Static on

Parameters

emitter: <internal>.EventEmitter

event: string

Returns <internal>.AsyncIterableIterator<any>

Static listenerCount

Parameters

emitter: <internal>.EventEmitter

event: string | symbol

Returns number

connect

Returns Promise<MongoClient>

Parameters

callback: <internal>.Callback<MongoClient>

Returns void

close

Returns Promise<void>

Parameters

force: boolean

Returns Promise<void>

Parameters

callback: <internal>.Callback<void>

Returns void

Parameters

force: boolean

callback: <internal>.Callback<void>

Returns void

db

Parameters

Optional dbName: string

Optional options: DbOptions

Returns Db

Static connect

Parameters

url: string

Returns Promise<MongoClient>

Parameters

url: string

options: MongoClientOptions

Returns Promise<MongoClient>

Parameters

url: string

callback: <internal>.Callback<MongoClient>

Returns void

Parameters

url: string

options: MongoClientOptions

callback: <internal>.Callback<MongoClient>

Returns void

startSession

Returns ClientSession

Parameters

options: ClientSessionOptions

Returns ClientSession

withSession

Parameters

callback: WithSessionCallback

Returns Promise<void>

Parameters

options: ClientSessionOptions

callback: WithSessionCallback

Returns Promise<void>

watch

Type Parameters