CancellationToken | mongodb (original) (raw)

Hierarchy

• TypedEventEmitter<{
  cancel() => void;
  }>
  • CancellationToken

Index

Constructors

constructor

• new CancellationToken(options?): CancellationToken

• Parameters

  • Optional options: EventEmitterOptions

Returns CancellationToken

Properties

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

Methods

addListener

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

• Type Parameters

  • EventKey extends "cancel"

Parameters

• event: EventKey

• listener: {

cancel() => void;
}[EventKey]

Returns CancellationToken

• addListener(event, listener): CancellationToken

• Parameters

  • event: CommonEvents

  • listener: ((eventName, listener) => void)

    * * (eventName, listener): void  
             * #### Returns void

Returns CancellationToken

• addListener(event, listener): CancellationToken

• Returns CancellationToken

emit

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

• Type Parameters

  • EventKey extends "cancel"

Parameters

• event: symbol | EventKey

• Rest ...args: Parameters<{

cancel() => void;
}[EventKey]>

Returns boolean

eventNames

• eventNames(): string[]

• Returns string[]

getMaxListeners

• getMaxListeners(): number

• Returns number

listenerCount

• listenerCount<EventKey>(type): number

• Type Parameters

  • EventKey extends "cancel"

Parameters

• type: string | symbol | EventKey

Returns number

listeners

• listeners<EventKey>(event): {
  cancel() => void;
  }[EventKey][]

• Type Parameters

  • EventKey extends "cancel"

Parameters

• event: string | symbol | EventKey

Returns {

cancel() => void;
}[EventKey][]

off

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

• Type Parameters

  • EventKey extends "cancel"

Parameters

• event: EventKey

• listener: {

cancel() => void;
}[EventKey]

Returns CancellationToken

• off(event, listener): CancellationToken

• Parameters

  • event: CommonEvents

  • listener: ((eventName, listener) => void)

    * * (eventName, listener): void  
             * #### Returns void

Returns CancellationToken

• off(event, listener): CancellationToken

• Returns CancellationToken

on

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

• Type Parameters

  • EventKey extends "cancel"

Parameters

• event: EventKey

• listener: {

cancel() => void;
}[EventKey]

Returns CancellationToken

• on(event, listener): CancellationToken

• Parameters

  • event: CommonEvents

  • listener: ((eventName, listener) => void)

    * * (eventName, listener): void  
             * #### Returns void

Returns CancellationToken

• on(event, listener): CancellationToken

• Returns CancellationToken

once

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

• Type Parameters

  • EventKey extends "cancel"

Parameters

• event: EventKey

• listener: {

cancel() => void;
}[EventKey]

Returns CancellationToken

• once(event, listener): CancellationToken

• Parameters

  • event: CommonEvents

  • listener: ((eventName, listener) => void)

    * * (eventName, listener): void  
             * #### Returns void

Returns CancellationToken

• once(event, listener): CancellationToken

• Returns CancellationToken

prependListener

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

• Type Parameters

  • EventKey extends "cancel"

Parameters

• event: EventKey

• listener: {

cancel() => void;
}[EventKey]

Returns CancellationToken

• prependListener(event, listener): CancellationToken

• Parameters

  • event: CommonEvents

  • listener: ((eventName, listener) => void)

    * * (eventName, listener): void  
             * #### Returns void

Returns CancellationToken

• prependListener(event, listener): CancellationToken

• Returns CancellationToken

prependOnceListener

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

• Type Parameters

  • EventKey extends "cancel"

Parameters

• event: EventKey

• listener: {

cancel() => void;
}[EventKey]

Returns CancellationToken

• prependOnceListener(event, listener): CancellationToken

• Parameters

  • event: CommonEvents

  • listener: ((eventName, listener) => void)

    * * (eventName, listener): void  
             * #### Returns void

Returns CancellationToken

• prependOnceListener(event, listener): CancellationToken

• Returns CancellationToken

rawListeners

• rawListeners<EventKey>(event): {
  cancel() => void;
  }[EventKey][]

• Type Parameters

  • EventKey extends "cancel"

Parameters

• event: string | symbol | EventKey

Returns {

cancel() => void;
}[EventKey][]

removeAllListeners

• removeAllListeners<EventKey>(event?): CancellationToken

• Type Parameters

  • EventKey extends "cancel"

Parameters

• Optional event: string | symbol | EventKey

Returns CancellationToken

removeListener

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

• Type Parameters

  • EventKey extends "cancel"

Parameters

• event: EventKey

• listener: {

cancel() => void;
}[EventKey]

Returns CancellationToken

• removeListener(event, listener): CancellationToken

• Parameters

  • event: CommonEvents

  • listener: ((eventName, listener) => void)

    * * (eventName, listener): void  
             * #### Returns void

Returns CancellationToken

• removeListener(event, listener): CancellationToken

• Returns CancellationToken

setMaxListeners

• setMaxListeners(n): CancellationToken

• Parameters

  • n: number

Returns CancellationToken

Static getEventListeners

• getEventListeners(emitter, name): Function[]

• Parameters

  • emitter: EventEmitter | _DOMEventTarget

  • name: string | symbol

Returns Function[]

Static listenerCount

• listenerCount(emitter, eventName): number

• Parameters

  • emitter: EventEmitter

  • eventName: string | symbol

Returns number

Static on

• on(emitter, eventName, options?): AsyncIterableIterator<any>

• Parameters

  • emitter: EventEmitter

  • eventName: string

  • Optional options: StaticEventEmitterOptions

Returns AsyncIterableIterator<any>

that iterates eventName events emitted by the emitter

Static once

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

• Parameters

  • emitter: _NodeEventTarget

  • eventName: string | symbol

  • Optional options: StaticEventEmitterOptions

Returns Promise<any[]>

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

• Parameters

  • emitter: _DOMEventTarget

  • eventName: string

  • Optional options: StaticEventEmitterOptions

Returns Promise<any[]>

Static setMaxListeners

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

• Parameters

  • Optional n: number

  • Rest ...eventTargets: (EventEmitter | _DOMEventTarget)[]

Returns void