CancellationToken

Hierarchy

TypedEventEmitter<{ cancel: any }>
- CancellationToken

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CancellationToken(options?: EventEmitterOptions): CancellationToken

Inherited from TypedEventEmitter.constructor
- Defined in node_modules/@types/node/events.d.ts:22
Parameters
- Optional options: EventEmitterOptions
Returns CancellationToken

Properties

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

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.

Methods

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 src/mongo_types.ts:342
Type parameters
- EventKey: "cancel"
Parameters
- event: EventKey
- listener: { cancel: any }[EventKey]
Returns CancellationToken
Inherited from TypedEventEmitter.addListener
- Defined in src/mongo_types.ts:343
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 src/mongo_types.ts:347
Parameters
- event: string | symbol
- listener: GenericListener
Returns CancellationToken

emit

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

Inherited from TypedEventEmitter.emit
- Defined in src/mongo_types.ts:389
Type parameters
- EventKey: "cancel"
Parameters
- event: symbol | EventKey
- Rest ...args: Parameters<{ cancel: any }[EventKey]>
Returns boolean

eventNames

eventNames(): string[]

Inherited from TypedEventEmitter.eventNames
- Defined in src/mongo_types.ts:415
Returns string[]

getMaxListeners

getMaxListeners(): number

Inherited from TypedEventEmitter.getMaxListeners
- Defined in src/mongo_types.ts:416
Returns number

listenerCount

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

Inherited from TypedEventEmitter.listenerCount
- Defined in src/mongo_types.ts:394
Type parameters
- EventKey: "cancel"
Parameters
- type: string | symbol | EventKey
Returns number

listeners

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

Inherited from TypedEventEmitter.listeners
- Defined in src/mongo_types.ts:381
Type parameters
- EventKey: "cancel"
Parameters
- event: string | symbol | EventKey
Returns { cancel: any }[EventKey][]

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 src/mongo_types.ts:370
Type parameters
- EventKey: "cancel"
Parameters
- event: EventKey
- listener: { cancel: any }[EventKey]
Returns CancellationToken
Inherited from TypedEventEmitter.off
- Defined in src/mongo_types.ts:371
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 src/mongo_types.ts:375
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 src/mongo_types.ts:349
Type parameters
- EventKey: "cancel"
Parameters
- event: EventKey
- listener: { cancel: any }[EventKey]
Returns CancellationToken
Inherited from TypedEventEmitter.on
- Defined in src/mongo_types.ts:350
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 src/mongo_types.ts:354
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 src/mongo_types.ts:356
Type parameters
- EventKey: "cancel"
Parameters
- event: EventKey
- listener: { cancel: any }[EventKey]
Returns CancellationToken
Inherited from TypedEventEmitter.once
- Defined in src/mongo_types.ts:357
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 src/mongo_types.ts:361
Parameters
- event: string | symbol
- listener: GenericListener
Returns CancellationToken

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 src/mongo_types.ts:398
Type parameters
- EventKey: "cancel"
Parameters
- event: EventKey
- listener: { cancel: any }[EventKey]
Returns CancellationToken
Inherited from TypedEventEmitter.prependListener
- Defined in src/mongo_types.ts:399
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 src/mongo_types.ts:403
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 src/mongo_types.ts:405
Type parameters
- EventKey: "cancel"
Parameters
- event: EventKey
- listener: { cancel: any }[EventKey]
Returns CancellationToken
Inherited from TypedEventEmitter.prependOnceListener
- Defined in src/mongo_types.ts:409
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 src/mongo_types.ts:413
Parameters
- event: string | symbol
- listener: GenericListener
Returns CancellationToken

rawListeners

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

Inherited from TypedEventEmitter.rawListeners
- Defined in src/mongo_types.ts:385
Type parameters
- EventKey: "cancel"
Parameters
- event: string | symbol | EventKey
Returns { cancel: any }[EventKey][]

removeAllListeners

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

Inherited from TypedEventEmitter.removeAllListeners
- Defined in src/mongo_types.ts:377
Type parameters
- EventKey: "cancel"
Parameters
- Optional event: string | symbol | EventKey
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 src/mongo_types.ts:363
Type parameters
- EventKey: "cancel"
Parameters
- event: EventKey
- listener: { cancel: any }[EventKey]
Returns CancellationToken
Inherited from TypedEventEmitter.removeListener
- Defined in src/mongo_types.ts:364
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 src/mongo_types.ts:368
Parameters
- event: string | symbol
- listener: GenericListener
Returns CancellationToken

setMaxListeners

setMaxListeners(n: number): CancellationToken

Inherited from TypedEventEmitter.setMaxListeners
- Defined in src/mongo_types.ts:417
Parameters
- n: number
Returns CancellationToken

Static getEventListener

getEventListener(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]

Inherited from TypedEventEmitter.getEventListener
- Defined in node_modules/@types/node/events.d.ts:34
Returns a list listener for a specific emitter event name.

Parameters
- emitter: DOMEventTarget | EventEmitter
- name: string | symbol
Returns Function[]

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from TypedEventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:30
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

on(emitter: EventEmitter, event: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>

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

Static once

once(emitter: NodeEventTarget, event: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
once(emitter: DOMEventTarget, event: string, options?: StaticEventEmitterOptions): Promise<any[]>

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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: EventEmitterOptions

Returns CancellationToken

Properties

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

addListener

Type parameters

EventKey: "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

emit

Type parameters

EventKey: "cancel"

Parameters

event: symbol | EventKey

Rest ...args: Parameters<{ cancel: any }[EventKey]>

Returns boolean

eventNames

Returns string[]

getMaxListeners

Returns number

listenerCount

Type parameters

EventKey: "cancel"

Parameters

type: string | symbol | EventKey

Returns number

listeners

Type parameters

EventKey: "cancel"

Parameters

event: string | symbol | EventKey

Returns { cancel: any }[EventKey][]

off

Type parameters

EventKey: "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: "cancel"