Class HsCancellationToken

Class representing a cancellation token for managing asynchronous operations.

Implements

CancellationToken

Index

Constructors

Properties

isCancelled onCancel?

Methods

cancel isCancellationRequested reset throwIfCancellationRequested

Constructors

constructor

new HsCancellationToken(): HsCancellationToken
Returns HsCancellationToken

Properties

`Private`isCancelled

isCancelled: boolean = false

Indicates whether the operation has been cancelled.

`Optional`onCancel

onCancel?: () => void

Callback function to execute when the operation is cancelled.

Methods

cancel

cancel(resetAfterCancel?: boolean): void
Cancels the operation and optionally resets the token after cancellation.
Parameters
- resetAfterCancel: boolean = false
  Whether to reset the token after cancellation.
Returns void

isCancellationRequested

isCancellationRequested(): boolean
Checks if a cancellation has been requested.

Returns boolean
True if cancellation is requested, false otherwise.

Implementation of CancellationToken.isCancellationRequested

reset

reset(): void
Resets the cancellation token to its initial state.

Returns void

throwIfCancellationRequested

throwIfCancellationRequested(): void
Throws an exception if cancellation has been requested.

Returns void
Throws
Error if the operation has been cancelled.

Implementation of CancellationToken.throwIfCancellationRequested