Class CancellationTokenSource

A cancellation source creates and controls a cancellation token.

Hierarchy

CancellationTokenSource

Index

Constructors

Properties

#isCancelled #isDisposed #listenerIdRef #listeners token

Accessors

Methods

Constructors

constructor

new CancellationTokenSource(): CancellationTokenSource
Returns CancellationTokenSource
- Defined in packages/util/src/cancellationToken.ts:35

Properties

`Private` #isCancelled

#isCancelled: boolean = false

`Private` #isDisposed

#isDisposed: boolean = false

`Private` #listenerIdRef

#listenerIdRef: number = 0

`Private` #listeners

#listeners: (() => unknown)[] = ...

Type declaration

- (): unknown
- Returns unknown

`Readonly` token

token: CancellationToken

The cancellation token of this source.

Accessors

isCancelled

get isCancelled(): boolean
Return true if a cancellation is already requested otherwise false;

Returns boolean
- Defined in packages/util/src/cancellationToken.ts:26

Methods

cancel

cancel(): Promise<void>
Signal cancellation on the token.

Returns Promise<void>
- Defined in packages/util/src/cancellationToken.ts:54

dispose

dispose(): void
Dispose object and free resources.

Returns void
- Defined in packages/util/src/cancellationToken.ts:75