Skip to main content

CancellationToken

FitFileViewer - API Documentation v29.4.0

FitFileViewer - API Documentation / utils/app/async/cancellationToken / CancellationToken

Class: CancellationToken

Defined in: utils/app/async/cancellationToken.js:10

Cancellation token for async operations

Constructors​

Constructor​

new CancellationToken(): CancellationToken

Defined in: utils/app/async/cancellationToken.js:21

Returns​

CancellationToken

Properties​

_isCancelled​

_isCancelled: boolean = false

Defined in: utils/app/async/cancellationToken.js:11

_callbacks​

_callbacks: () => void[]

Defined in: utils/app/async/cancellationToken.js:25

Returns​

void

Accessors​

isCancelled​

Get Signature​

get isCancelled(): boolean

Defined in: utils/app/async/cancellationToken.js:17

Check if operation is cancelled

Returns​

boolean

Methods​

cancel()​

cancel(): void

Defined in: utils/app/async/cancellationToken.js:31

Cancel the operation

Returns​

void

onCancel()​

onCancel(callback: () => void): () => void

Defined in: utils/app/async/cancellationToken.js:55

Register a callback to be called when cancelled

Parameters​

callback​

() => void

Callback function

Returns​

Unsubscribe function

(): void

Returns​

void

throwIfCancelled()​

throwIfCancelled(): void

Defined in: utils/app/async/cancellationToken.js:84

Throw if cancelled

Returns​

void

Throws​

If operation is cancelled