MongoClient | mongodb (original) (raw)

Optional[captureRejectionSymbol]

• [captureRejectionSymbol]<K>(error, event, ...args): void

• Type Parameters

  • K

Parameters

• error: Error
• event: string | symbol
• Rest...args: AnyRest

Returns void

addListener

• addListener<EventKey>(event, listener): this

• Type Parameters

  • EventKey extends
    | "error"
    | "timeout"
    | "close"
    | "open"
    | "serverOpening"
    | "serverClosed"
    | "serverDescriptionChanged"
    | "topologyOpening"
    | "topologyClosed"
    | "topologyDescriptionChanged"
    | "connectionPoolCreated"
    | "connectionPoolClosed"
    | "connectionPoolCleared"
    | "connectionPoolReady"
    | "connectionCreated"
    | "connectionReady"
    | "connectionClosed"
    | "connectionCheckOutStarted"
    | "connectionCheckOutFailed"
    | "connectionCheckedOut"
    | "connectionCheckedIn"
    | "commandStarted"
    | "commandSucceeded"
    | "commandFailed"
    | "serverHeartbeatStarted"
    | "serverHeartbeatSucceeded"
    | "serverHeartbeatFailed"

Returns this

• addListener(event, listener): this

• Parameters

  • event: CommonEvents
  • listener: ((eventName: string | symbol, listener: GenericListener) => void)
    * * (eventName, listener): void
    * #### Returns void

Returns this

• addListener(event, listener): this

• Returns this

bulkWrite

• bulkWrite<SchemaMap>(models, options?): Promise<ClientBulkWriteResult>

• Type Parameters

  • SchemaMap extends Record<string, Document> = Record<string, Document>

Returns Promise<ClientBulkWriteResult>

A ClientBulkWriteResult for acknowledged writes and ok: 1 for unacknowledged writes.

close

• close(force?): Promise<void>

• Parameters

  • force: boolean = false

Returns Promise<void>

connect

• connect(): Promise<MongoClient>

• Returns Promise<MongoClient>

db

• db(dbName?, options?): Db

• Parameters

  • OptionaldbName: string
  • Optionaloptions: DbOptions

Returns Db

emit

• emit<EventKey>(event, ...args): boolean

• Type Parameters

  • EventKey extends
    | "error"
    | "timeout"
    | "close"
    | "open"
    | "serverOpening"
    | "serverClosed"
    | "serverDescriptionChanged"
    | "topologyOpening"
    | "topologyClosed"
    | "topologyDescriptionChanged"
    | "connectionPoolCreated"
    | "connectionPoolClosed"
    | "connectionPoolCleared"
    | "connectionPoolReady"
    | "connectionCreated"
    | "connectionReady"
    | "connectionClosed"
    | "connectionCheckOutStarted"
    | "connectionCheckOutFailed"
    | "connectionCheckedOut"
    | "connectionCheckedIn"
    | "commandStarted"
    | "commandSucceeded"
    | "commandFailed"
    | "serverHeartbeatStarted"
    | "serverHeartbeatSucceeded"
    | "serverHeartbeatFailed"

Returns boolean

eventNames

• eventNames(): string[]

• Returns string[]

getMaxListeners

• getMaxListeners(): number

• Returns number

listenerCount

• listenerCount<EventKey>(type): number

• Type Parameters

  • EventKey extends
    | "error"
    | "timeout"
    | "close"
    | "open"
    | "serverOpening"
    | "serverClosed"
    | "serverDescriptionChanged"
    | "topologyOpening"
    | "topologyClosed"
    | "topologyDescriptionChanged"
    | "connectionPoolCreated"
    | "connectionPoolClosed"
    | "connectionPoolCleared"
    | "connectionPoolReady"
    | "connectionCreated"
    | "connectionReady"
    | "connectionClosed"
    | "connectionCheckOutStarted"
    | "connectionCheckOutFailed"
    | "connectionCheckedOut"
    | "connectionCheckedIn"
    | "commandStarted"
    | "commandSucceeded"
    | "commandFailed"
    | "serverHeartbeatStarted"
    | "serverHeartbeatSucceeded"
    | "serverHeartbeatFailed"

Parameters

• type: string | symbol | EventKey

Returns number

listeners

• listeners<EventKey>(event): MongoClientEvents[EventKey][]

• Type Parameters

  • EventKey extends
    | "error"
    | "timeout"
    | "close"
    | "open"
    | "serverOpening"
    | "serverClosed"
    | "serverDescriptionChanged"
    | "topologyOpening"
    | "topologyClosed"
    | "topologyDescriptionChanged"
    | "connectionPoolCreated"
    | "connectionPoolClosed"
    | "connectionPoolCleared"
    | "connectionPoolReady"
    | "connectionCreated"
    | "connectionReady"
    | "connectionClosed"
    | "connectionCheckOutStarted"
    | "connectionCheckOutFailed"
    | "connectionCheckedOut"
    | "connectionCheckedIn"
    | "commandStarted"
    | "commandSucceeded"
    | "commandFailed"
    | "serverHeartbeatStarted"
    | "serverHeartbeatSucceeded"
    | "serverHeartbeatFailed"

Parameters

• event: string | symbol | EventKey

Returns MongoClientEvents[EventKey][]

off

• off<EventKey>(event, listener): this

• Type Parameters

  • EventKey extends
    | "error"
    | "timeout"
    | "close"
    | "open"
    | "serverOpening"
    | "serverClosed"
    | "serverDescriptionChanged"
    | "topologyOpening"
    | "topologyClosed"
    | "topologyDescriptionChanged"
    | "connectionPoolCreated"
    | "connectionPoolClosed"
    | "connectionPoolCleared"
    | "connectionPoolReady"
    | "connectionCreated"
    | "connectionReady"
    | "connectionClosed"
    | "connectionCheckOutStarted"
    | "connectionCheckOutFailed"
    | "connectionCheckedOut"
    | "connectionCheckedIn"
    | "commandStarted"
    | "commandSucceeded"
    | "commandFailed"
    | "serverHeartbeatStarted"
    | "serverHeartbeatSucceeded"
    | "serverHeartbeatFailed"

Returns this

• off(event, listener): this

• Parameters

  • event: CommonEvents
  • listener: ((eventName: string | symbol, listener: GenericListener) => void)
    * * (eventName, listener): void
    * #### Returns void

Returns this

• off(event, listener): this

• Returns this

on

• on<EventKey>(event, listener): this

• Type Parameters

  • EventKey extends
    | "error"
    | "timeout"
    | "close"
    | "open"
    | "serverOpening"
    | "serverClosed"
    | "serverDescriptionChanged"
    | "topologyOpening"
    | "topologyClosed"
    | "topologyDescriptionChanged"
    | "connectionPoolCreated"
    | "connectionPoolClosed"
    | "connectionPoolCleared"
    | "connectionPoolReady"
    | "connectionCreated"
    | "connectionReady"
    | "connectionClosed"
    | "connectionCheckOutStarted"
    | "connectionCheckOutFailed"
    | "connectionCheckedOut"
    | "connectionCheckedIn"
    | "commandStarted"
    | "commandSucceeded"
    | "commandFailed"
    | "serverHeartbeatStarted"
    | "serverHeartbeatSucceeded"
    | "serverHeartbeatFailed"

Returns this

• on(event, listener): this

• Parameters

  • event: CommonEvents
  • listener: ((eventName: string | symbol, listener: GenericListener) => void)
    * * (eventName, listener): void
    * #### Returns void

Returns this

• on(event, listener): this

• Returns this

once

• once<EventKey>(event, listener): this

• Type Parameters

  • EventKey extends
    | "error"
    | "timeout"
    | "close"
    | "open"
    | "serverOpening"
    | "serverClosed"
    | "serverDescriptionChanged"
    | "topologyOpening"
    | "topologyClosed"
    | "topologyDescriptionChanged"
    | "connectionPoolCreated"
    | "connectionPoolClosed"
    | "connectionPoolCleared"
    | "connectionPoolReady"
    | "connectionCreated"
    | "connectionReady"
    | "connectionClosed"
    | "connectionCheckOutStarted"
    | "connectionCheckOutFailed"
    | "connectionCheckedOut"
    | "connectionCheckedIn"
    | "commandStarted"
    | "commandSucceeded"
    | "commandFailed"
    | "serverHeartbeatStarted"
    | "serverHeartbeatSucceeded"
    | "serverHeartbeatFailed"

Returns this

• once(event, listener): this

• Parameters

  • event: CommonEvents
  • listener: ((eventName: string | symbol, listener: GenericListener) => void)
    * * (eventName, listener): void
    * #### Returns void

Returns this

• once(event, listener): this

• Returns this

prependListener

• prependListener<EventKey>(event, listener): this

• Type Parameters

  • EventKey extends
    | "error"
    | "timeout"
    | "close"
    | "open"
    | "serverOpening"
    | "serverClosed"
    | "serverDescriptionChanged"
    | "topologyOpening"
    | "topologyClosed"
    | "topologyDescriptionChanged"
    | "connectionPoolCreated"
    | "connectionPoolClosed"
    | "connectionPoolCleared"
    | "connectionPoolReady"
    | "connectionCreated"
    | "connectionReady"
    | "connectionClosed"
    | "connectionCheckOutStarted"
    | "connectionCheckOutFailed"
    | "connectionCheckedOut"
    | "connectionCheckedIn"
    | "commandStarted"
    | "commandSucceeded"
    | "commandFailed"
    | "serverHeartbeatStarted"
    | "serverHeartbeatSucceeded"
    | "serverHeartbeatFailed"

Returns this

• prependListener(event, listener): this

• Parameters

  • event: CommonEvents
  • listener: ((eventName: string | symbol, listener: GenericListener) => void)
    * * (eventName, listener): void
    * #### Returns void

Returns this

• prependListener(event, listener): this

• Returns this

prependOnceListener

• prependOnceListener<EventKey>(event, listener): this

• Type Parameters

  • EventKey extends
    | "error"
    | "timeout"
    | "close"
    | "open"
    | "serverOpening"
    | "serverClosed"
    | "serverDescriptionChanged"
    | "topologyOpening"
    | "topologyClosed"
    | "topologyDescriptionChanged"
    | "connectionPoolCreated"
    | "connectionPoolClosed"
    | "connectionPoolCleared"
    | "connectionPoolReady"
    | "connectionCreated"
    | "connectionReady"
    | "connectionClosed"
    | "connectionCheckOutStarted"
    | "connectionCheckOutFailed"
    | "connectionCheckedOut"
    | "connectionCheckedIn"
    | "commandStarted"
    | "commandSucceeded"
    | "commandFailed"
    | "serverHeartbeatStarted"
    | "serverHeartbeatSucceeded"
    | "serverHeartbeatFailed"

Returns this

• prependOnceListener(event, listener): this

• Parameters

  • event: CommonEvents
  • listener: ((eventName: string | symbol, listener: GenericListener) => void)
    * * (eventName, listener): void
    * #### Returns void

Returns this

• prependOnceListener(event, listener): this

• Returns this

rawListeners

• rawListeners<EventKey>(event): MongoClientEvents[EventKey][]

• Type Parameters

  • EventKey extends
    | "error"
    | "timeout"
    | "close"
    | "open"
    | "serverOpening"
    | "serverClosed"
    | "serverDescriptionChanged"
    | "topologyOpening"
    | "topologyClosed"
    | "topologyDescriptionChanged"
    | "connectionPoolCreated"
    | "connectionPoolClosed"
    | "connectionPoolCleared"
    | "connectionPoolReady"
    | "connectionCreated"
    | "connectionReady"
    | "connectionClosed"
    | "connectionCheckOutStarted"
    | "connectionCheckOutFailed"
    | "connectionCheckedOut"
    | "connectionCheckedIn"
    | "commandStarted"
    | "commandSucceeded"
    | "commandFailed"
    | "serverHeartbeatStarted"
    | "serverHeartbeatSucceeded"
    | "serverHeartbeatFailed"

Parameters

• event: string | symbol | EventKey

Returns MongoClientEvents[EventKey][]

removeAllListeners

• removeAllListeners<EventKey>(event?): this

• Type Parameters

  • EventKey extends
    | "error"
    | "timeout"
    | "close"
    | "open"
    | "serverOpening"
    | "serverClosed"
    | "serverDescriptionChanged"
    | "topologyOpening"
    | "topologyClosed"
    | "topologyDescriptionChanged"
    | "connectionPoolCreated"
    | "connectionPoolClosed"
    | "connectionPoolCleared"
    | "connectionPoolReady"
    | "connectionCreated"
    | "connectionReady"
    | "connectionClosed"
    | "connectionCheckOutStarted"
    | "connectionCheckOutFailed"
    | "connectionCheckedOut"
    | "connectionCheckedIn"
    | "commandStarted"
    | "commandSucceeded"
    | "commandFailed"
    | "serverHeartbeatStarted"
    | "serverHeartbeatSucceeded"
    | "serverHeartbeatFailed"

Parameters

• Optionalevent: string | symbol | EventKey

Returns this

removeListener

• removeListener<EventKey>(event, listener): this

• Type Parameters

  • EventKey extends
    | "error"
    | "timeout"
    | "close"
    | "open"
    | "serverOpening"
    | "serverClosed"
    | "serverDescriptionChanged"
    | "topologyOpening"
    | "topologyClosed"
    | "topologyDescriptionChanged"
    | "connectionPoolCreated"
    | "connectionPoolClosed"
    | "connectionPoolCleared"
    | "connectionPoolReady"
    | "connectionCreated"
    | "connectionReady"
    | "connectionClosed"
    | "connectionCheckOutStarted"
    | "connectionCheckOutFailed"
    | "connectionCheckedOut"
    | "connectionCheckedIn"
    | "commandStarted"
    | "commandSucceeded"
    | "commandFailed"
    | "serverHeartbeatStarted"
    | "serverHeartbeatSucceeded"
    | "serverHeartbeatFailed"

Returns this

• removeListener(event, listener): this

• Parameters

  • event: CommonEvents
  • listener: ((eventName: string | symbol, listener: GenericListener) => void)
    * * (eventName, listener): void
    * #### Returns void

Returns this

• removeListener(event, listener): this

• Returns this

setMaxListeners

• setMaxListeners(n): this

• Returns this

startSession

• startSession(options?): ClientSession

• Returns ClientSession

watch

• watch<TSchema, TChange>(pipeline?, options?): ChangeStream<TSchema, TChange>

• Type Parameters

  • TSchema extends Document = Document
  • TChange extends Document = ChangeStreamDocument<TSchema>

Returns ChangeStream<TSchema, TChange>

withSession

• withSession<T>(executor): Promise<T>

• Type Parameters

  • T = any

Returns Promise<T>

• withSession<T>(options, executor): Promise<T>

• Type Parameters

  • T = any

Returns Promise<T>

StaticaddAbortListener

• addAbortListener(signal, resource): Disposable
• Experimental

Parameters

• signal: AbortSignal
• resource: ((event: Event) => void)
  * * (event): void
  * #### Returns void

Returns Disposable

Disposable that removes the abort listener.

Staticconnect

• connect(url, options?): Promise<MongoClient>

• Returns Promise<MongoClient>

StaticgetEventListeners

• getEventListeners(emitter, name): Function[]

• Parameters

  • emitter: EventEmitter<DefaultEventMap> | EventTarget
  • name: string | symbol

Returns Function[]

StaticgetMaxListeners

• getMaxListeners(emitter): number

• Parameters

  • emitter: EventEmitter<DefaultEventMap> | EventTarget

Returns number

StaticlistenerCount

• listenerCount(emitter, eventName): number

• Parameters

  • emitter: EventEmitter<DefaultEventMap>
  • eventName: string | symbol

Returns number

Staticon

• on(emitter, eventName, options?): AsyncIterator<any[], any, any>

• Parameters

  • emitter: EventEmitter<DefaultEventMap>
  • eventName: string | symbol
  • Optionaloptions: StaticEventEmitterIteratorOptions

Returns AsyncIterator<any[], any, any>

An AsyncIterator that iterates eventName events emitted by the emitter

• on(emitter, eventName, options?): AsyncIterator<any[], any, any>

• Parameters

  • emitter: EventTarget
  • eventName: string
  • Optionaloptions: StaticEventEmitterIteratorOptions

Returns AsyncIterator<any[], any, any>

Staticonce

• once(emitter, eventName, options?): Promise<any[]>

• Parameters

  • emitter: EventEmitter<DefaultEventMap>
  • eventName: string | symbol
  • Optionaloptions: StaticEventEmitterOptions

Returns Promise<any[]>

• once(emitter, eventName, options?): Promise<any[]>

• Parameters

  • emitter: EventTarget
  • eventName: string
  • Optionaloptions: StaticEventEmitterOptions

Returns Promise<any[]>

StaticsetMaxListeners

• setMaxListeners(n?, ...eventTargets): void

• Parameters

  • Optionaln: number
  • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

Returns void