ClientSession | 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

abortTransaction

• abortTransaction(options?): Promise<void>

• Parameters

  • Optionaloptions: {
    timeoutMS?: number;
    }
    * ##### OptionaltimeoutMS?: number

Returns Promise<void>

addListener

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

• Type Parameters

  • EventKey extends "ended"

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

advanceClusterTime

• advanceClusterTime(clusterTime): void

• Returns void

advanceOperationTime

• advanceOperationTime(operationTime): void

• Returns void

commitTransaction

• commitTransaction(options?): Promise<void>

• Parameters

  • Optionaloptions: {
    timeoutMS?: number;
    }
    * ##### OptionaltimeoutMS?: number

Returns Promise<void>

emit

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

• Type Parameters

  • EventKey extends "ended"

Returns boolean

endSession

• endSession(options?): Promise<void>

• Returns Promise<void>

equals

• equals(session): boolean

• Returns boolean

eventNames

• eventNames(): string[]

• Returns string[]

getMaxListeners

• getMaxListeners(): number

• Returns number

incrementTransactionNumber

• incrementTransactionNumber(): void

• Returns void

inTransaction

• inTransaction(): boolean

• Returns boolean

whether this session is currently in a transaction or not

listenerCount

• listenerCount<EventKey>(type): number

• Type Parameters

  • EventKey extends "ended"

Parameters

• type: string | symbol | EventKey

Returns number

listeners

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

• Type Parameters

  • EventKey extends "ended"

Parameters

• event: string | symbol | EventKey

Returns ClientSessionEvents[EventKey][]

off

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

• Type Parameters

  • EventKey extends "ended"

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 "ended"

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 "ended"

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 "ended"

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 "ended"

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): ClientSessionEvents[EventKey][]

• Type Parameters

  • EventKey extends "ended"

Parameters

• event: string | symbol | EventKey

Returns ClientSessionEvents[EventKey][]

removeAllListeners

• removeAllListeners<EventKey>(event?): this

• Type Parameters

  • EventKey extends "ended"

Parameters

• Optionalevent: string | symbol | EventKey

Returns this

removeListener

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

• Type Parameters

  • EventKey extends "ended"

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

startTransaction

• startTransaction(options?): void

• Returns void

toBSON

• toBSON(): never

• Returns never

withTransaction

• withTransaction<T>(fn, options?): Promise<T>

• Type Parameters

  • T = any

Parameters

• fn: WithTransactionCallback<T>
• Optionaloptions: TransactionOptions & {
  timeoutMS?: number;
  }

Returns Promise<T>

A raw command response or undefined

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.

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