Class CancellationTokenSource

Represents an owner of ICancellationToken that can initiates the cancellation.

Hierarchy

CancellationTokenSource

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new CancellationTokenSource(cancelAfterDelay?: undefined | number): CancellationTokenSource

- Defined in packages/tasklike-promise-library/src/primitives/cancellation.ts:137
Parameters
- Optional cancelAfterDelay: undefined | number
  
  Automatically requests cancellation after the specified non-negative time in milliseconds.
Returns CancellationTokenSource

Accessors

isCancellationRequested

get isCancellationRequested(): boolean

- Defined in packages/tasklike-promise-library/src/primitives/cancellation.ts:147
Whether the cancellation has been requested.

Returns boolean

token

get token(): ICancellationToken

- Defined in packages/tasklike-promise-library/src/primitives/cancellation.ts:176
Gets the derived ICancellationToken from this token source.

Returns ICancellationToken

Methods

cancel

cancel(): void

- Defined in packages/tasklike-promise-library/src/primitives/cancellation.ts:154
Initiates cancellation if it has not been requested yet. Notifies the derived ICancellationToken of the cancellation.

Returns void

cancelAfter

cancelAfter(delay: number): void

- Defined in packages/tasklike-promise-library/src/primitives/cancellation.ts:165
Initiates cancellation after the specified delay.

Parameters
- delay: number
  
  the non-negative time in milliseconds to wait before initiating the cancellation.
Returns void

Static race

race(...cancellationTokens: Array<ICancellationToken | null | undefined>): CancellationTokenSource

- Defined in packages/tasklike-promise-library/src/primitives/cancellation.ts:186
Gets a CancellationTokenSource that gets cancelled when any of the specified ICancellationToken gets cancelled.

Parameters
- Rest ...cancellationTokens: Array<ICancellationToken | null | undefined>
  
  One or more underlying ICancellationToken.
Returns CancellationTokenSource

Generated using TypeDoc