CancellationToken | Documentation

Hierarchy

TypedEventEmitter<{ cancel: any }>
- CancellationToken

Constructors

constructor

new CancellationToken(): CancellationToken

Inherited from TypedEventEmitter.constructor
- Defined in node_modules/@types/node/events.d.ts:11
Returns CancellationToken

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

addListener

addListener<EventKey>(event: EventKey, listener: { cancel: any }[EventKey]): CancellationToken
addListener(event: CommonEvents, listener: ((eventName: string | symbol, listener: GenericListener) => void)): CancellationToken
addListener(event: string | symbol, listener: GenericListener): CancellationToken

Inherited from TypedEventEmitter.addListener
- Defined in node_modules/mongodb/mongodb.d.ts:6481
Type Parameters
- EventKey extends "cancel"
Parameters
- event: EventKey
- listener: { cancel: any }[EventKey]
Returns CancellationToken
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 CancellationToken
Inherited from TypedEventEmitter.addListener
- Defined in node_modules/mongodb/mongodb.d.ts:6483
Parameters
- event: string | symbol
- listener: GenericListener
Returns CancellationToken

on

on<EventKey>(event: EventKey, listener: { cancel: any }[EventKey]): CancellationToken
on(event: CommonEvents, listener: ((eventName: string | symbol, listener: GenericListener) => void)): CancellationToken
on(event: string | symbol, listener: GenericListener): CancellationToken

Inherited from TypedEventEmitter.on
- Defined in node_modules/mongodb/mongodb.d.ts:6484
Type Parameters
- EventKey extends "cancel"
Parameters
- event: EventKey
- listener: { cancel: any }[EventKey]
Returns CancellationToken
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 CancellationToken
Inherited from TypedEventEmitter.on
- Defined in node_modules/mongodb/mongodb.d.ts:6486
Parameters
- event: string | symbol
- listener: GenericListener
Returns CancellationToken

once

once<EventKey>(event: EventKey, listener: { cancel: any }[EventKey]): CancellationToken
once(event: CommonEvents, listener: ((eventName: string | symbol, listener: GenericListener) => void)): CancellationToken
once(event: string | symbol, listener: GenericListener): CancellationToken

Inherited from TypedEventEmitter.once
- Defined in node_modules/mongodb/mongodb.d.ts:6487
Type Parameters
- EventKey extends "cancel"
Parameters
- event: EventKey
- listener: { cancel: any }[EventKey]
Returns CancellationToken
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 CancellationToken
Inherited from TypedEventEmitter.once
- Defined in node_modules/mongodb/mongodb.d.ts:6489
Parameters
- event: string | symbol
- listener: GenericListener
Returns CancellationToken

removeListener

removeListener<EventKey>(event: EventKey, listener: { cancel: any }[EventKey]): CancellationToken
removeListener(event: CommonEvents, listener: ((eventName: string | symbol, listener: GenericListener) => void)): CancellationToken
removeListener(event: string | symbol, listener: GenericListener): CancellationToken

Inherited from TypedEventEmitter.removeListener
- Defined in node_modules/mongodb/mongodb.d.ts:6490
Type Parameters
- EventKey extends "cancel"
Parameters
- event: EventKey
- listener: { cancel: any }[EventKey]
Returns CancellationToken
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 CancellationToken
Inherited from TypedEventEmitter.removeListener
- Defined in node_modules/mongodb/mongodb.d.ts:6492
Parameters
- event: string | symbol
- listener: GenericListener
Returns CancellationToken

off

off<EventKey>(event: EventKey, listener: { cancel: any }[EventKey]): CancellationToken
off(event: CommonEvents, listener: ((eventName: string | symbol, listener: GenericListener) => void)): CancellationToken
off(event: string | symbol, listener: GenericListener): CancellationToken

Inherited from TypedEventEmitter.off
- Defined in node_modules/mongodb/mongodb.d.ts:6493
Type Parameters
- EventKey extends "cancel"
Parameters
- event: EventKey
- listener: { cancel: any }[EventKey]
Returns CancellationToken
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 CancellationToken
Inherited from TypedEventEmitter.off
- Defined in node_modules/mongodb/mongodb.d.ts:6495
Parameters
- event: string | symbol
- listener: GenericListener
Returns CancellationToken

removeAllListeners

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

Inherited from TypedEventEmitter.removeAllListeners
- Defined in node_modules/mongodb/mongodb.d.ts:6496
Type Parameters
- EventKey extends "cancel"
Parameters
- Optional event: string | symbol | EventKey
Returns CancellationToken

listeners

listeners<EventKey>(event: string | symbol | EventKey): { cancel: any }[EventKey][]

Inherited from TypedEventEmitter.listeners
- Defined in node_modules/mongodb/mongodb.d.ts:6497
Type Parameters
- EventKey extends "cancel"
Parameters
- event: string | symbol | EventKey
Returns { cancel: any }[EventKey][]

rawListeners

rawListeners<EventKey>(event: string | symbol | EventKey): { cancel: any }[EventKey][]

Inherited from TypedEventEmitter.rawListeners
- Defined in node_modules/mongodb/mongodb.d.ts:6498
Type Parameters
- EventKey extends "cancel"
Parameters
- event: string | symbol | EventKey
Returns { cancel: any }[EventKey][]

emit

emit<EventKey>(event: symbol | EventKey, ...args: Parameters<{ cancel: any }[EventKey]>): boolean

Inherited from TypedEventEmitter.emit
- Defined in node_modules/mongodb/mongodb.d.ts:6499
Type Parameters
- EventKey extends "cancel"
Parameters
- event: symbol | EventKey
- Rest ...args: Parameters<{ cancel: any }[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 "cancel"
Parameters
- type: string | symbol | EventKey
Returns number

prependListener

prependListener<EventKey>(event: EventKey, listener: { cancel: any }[EventKey]): CancellationToken
prependListener(event: CommonEvents, listener: ((eventName: string | symbol, listener: GenericListener) => void)): CancellationToken
prependListener(event: string | symbol, listener: GenericListener): CancellationToken

Inherited from TypedEventEmitter.prependListener
- Defined in node_modules/mongodb/mongodb.d.ts:6501
Type Parameters
- EventKey extends "cancel"
Parameters
- event: EventKey
- listener: { cancel: any }[EventKey]
Returns CancellationToken
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 CancellationToken
Inherited from TypedEventEmitter.prependListener
- Defined in node_modules/mongodb/mongodb.d.ts:6503
Parameters
- event: string | symbol
- listener: GenericListener
Returns CancellationToken

prependOnceListener

prependOnceListener<EventKey>(event: EventKey, listener: { cancel: any }[EventKey]): CancellationToken
prependOnceListener(event: CommonEvents, listener: ((eventName: string | symbol, listener: GenericListener) => void)): CancellationToken
prependOnceListener(event: string | symbol, listener: GenericListener): CancellationToken

Inherited from TypedEventEmitter.prependOnceListener
- Defined in node_modules/mongodb/mongodb.d.ts:6504
Type Parameters
- EventKey extends "cancel"
Parameters
- event: EventKey
- listener: { cancel: any }[EventKey]
Returns CancellationToken
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 CancellationToken
Inherited from TypedEventEmitter.prependOnceListener
- Defined in node_modules/mongodb/mongodb.d.ts:6506
Parameters
- event: string | symbol
- listener: GenericListener
Returns CancellationToken

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): CancellationToken

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

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

Hierarchy

Index

Constructors

Methods

Properties

Constructors

constructor

Returns CancellationToken

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

addListener

Type Parameters

EventKey extends "cancel"

Parameters

event: EventKey

listener: { cancel: any }[EventKey]

Returns CancellationToken

Parameters

event: CommonEvents

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

Parameters

eventName: string | symbol

listener: GenericListener

Returns void

Returns CancellationToken

Parameters

event: string | symbol

listener: GenericListener

Returns CancellationToken

on

Type Parameters

EventKey extends "cancel"

Parameters

event: EventKey

listener: { cancel: any }[EventKey]

Returns CancellationToken

Parameters

event: CommonEvents

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

Parameters

eventName: string | symbol

listener: GenericListener

Returns void

Returns CancellationToken

Parameters

event: string | symbol

listener: GenericListener

Returns CancellationToken

once

Type Parameters

EventKey extends "cancel"

Parameters

event: EventKey

listener: { cancel: any }[EventKey]

Returns CancellationToken

Parameters

event: CommonEvents

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

Parameters

eventName: string | symbol

listener: GenericListener

Returns void