Class CancellableHandle<T>

Handle for a cancellable task that extends Defer with cancellation capabilities. Provides methods to cancel the task and check its cancellation status.

Type Parameters

T
The type of the task result

Hierarchy (View Summary)

Defer<T>
- CancellableHandle
  - TaskHandle

Index

Constructors

constructor

new CancellableHandle<T>(
abortController: AbortController,
name?: string,
): CancellableHandle<T>
Creates a new CancellableHandle instance.
Type Parameters
- T
  The type of the task result
Parameters
- abortController: AbortController
  The AbortController used to manage cancellation
- Optionalname: string
  Optional name for this handle, used for debugging
Returns CancellableHandle<T>
Overrides Defer.constructor
- Defined in packages/core/src/cancellable/CancellableHandle.ts:37

Properties

[CANCEL_REASON]

"[CANCEL_REASON]": CancelError | null = null

`Optional` `Readonly`name

name?: string

`Readonly`promise

promise: Promise<T>

`Readonly`reject

reject: (reason?: unknown) => void

`Readonly`resolve

resolve: (value: T | PromiseLike<T>) => void

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns string
Inherited from Defer.[toStringTag]
- Defined in packages/core/src/utils/Defer.ts:162

cancelError

get cancelError(): CancelError | null
Gets the cancellation error if the task has been cancelled. Returns null if the task has not been cancelled.

Returns CancelError | null
The CancelError that caused the cancellation, or null if not cancelled
- Defined in packages/core/src/cancellable/CancellableHandle.ts:22

cancelReason

get cancelReason(): CancelError | null
Backward-compatible alias for older consumers.

Returns CancelError | null
- Defined in packages/core/src/cancellable/CancellableHandle.ts:29

isSettled

get isSettled(): boolean
Indicates whether the promise has been settled (resolved or rejected)

Returns boolean
Inherited from Defer.isSettled
- Defined in packages/core/src/utils/Defer.ts:53

rejectReason

get rejectReason(): unknown
Gets the rejection reason if the promise was rejected

Returns unknown
Inherited from Defer.rejectReason
- Defined in packages/core/src/utils/Defer.ts:46

resolveValue

get resolveValue(): T | undefined
Gets the resolved value if the promise was resolved

Returns T | undefined
Inherited from Defer.resolveValue
- Defined in packages/core/src/utils/Defer.ts:39

signal

get signal(): AbortSignal
Gets the AbortSignal associated with this handle.

Returns AbortSignal
The AbortSignal for monitoring cancellation
- Defined in packages/core/src/cancellable/CancellableHandle.ts:50

Methods

cancel

cancel(reason?: unknown): void
Cancels the task with an optional reason.
Parameters
- Optionalreason: unknown
  Optional reason for cancellation
Returns void
- Defined in packages/core/src/cancellable/CancellableHandle.ts:66

catch

catch<TResult = never>(
    onrejected?:
        | ((reason: unknown) => TResult | PromiseLike<TResult>)
        | null,
): Defer<T | TResult>
Attaches a callback for only the rejection of the Promise
Type Parameters
- TResult = never
Parameters
- Optionalonrejected: ((reason: unknown) => TResult | PromiseLike<TResult>) | null
Returns Defer<T | TResult>
A new Defer instance
Inherited from Defer.catch
- Defined in packages/core/src/utils/Defer.ts:136

finally

finally(onfinally?: (() => void) | null): Defer<T>
Attaches a callback that is invoked when the Promise is settled
Parameters
- Optionalonfinally: (() => void) | null
Returns Defer<T>
A new Defer instance
Inherited from Defer.finally
- Defined in packages/core/src/utils/Defer.ts:154

isCancelled

isCancelled(): boolean
Checks if the task has been cancelled.

Returns boolean
True if the task has been cancelled, false otherwise
- Defined in packages/core/src/cancellable/CancellableHandle.ts:58

then

then<TResult1 = T, TResult2 = never>(
onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null,
onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null,
): Defer<TResult1 | TResult2>
Attaches callbacks for the resolution and/or rejection of the Promise
Type Parameters
- TResult1 = T
- TResult2 = never
Parameters
- Optionalonfulfilled: ((value: T) => TResult1 | PromiseLike<TResult1>) | null
- Optionalonrejected: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null
Returns Defer<TResult1 | TResult2>
A new Defer instance
Inherited from Defer.then
- Defined in packages/core/src/utils/Defer.ts:114

`Static`reject

reject<T>(reason: unknown): Defer<T>
Creates a pre-rejected Defer instance
Type Parameters
- T
Parameters
- reason: unknown
  The rejection reason
Returns Defer<T>
A rejected Defer instance
Inherited from Defer.reject
- Defined in packages/core/src/utils/Defer.ts:22

`Static`resolve

resolve<T>(value: T): Defer<T>
Creates a pre-resolved Defer instance
Type Parameters
- T
Parameters
- value: T
  The value to resolve with
Returns Defer<T>
A resolved Defer instance
Inherited from Defer.resolve
- Defined in packages/core/src/utils/Defer.ts:11

Class CancellableHandle<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CancellableHandle<T>

Properties

[CANCEL_REASON]

Optional Readonlyname

Readonlypromise

Readonlyreject

Readonlyresolve

Accessors

[toStringTag]

Returns string

cancelError

Returns CancelError | null

cancelReason

Returns CancelError | null

isSettled

Returns boolean

rejectReason

Returns unknown

resolveValue

Returns T | undefined

signal

Returns AbortSignal

Methods

cancel

Parameters

Returns void

catch

Type Parameters

Parameters

Returns Defer<T | TResult>

finally

Parameters

Returns Defer<T>

isCancelled

Returns boolean

then

Type Parameters

Parameters

Returns Defer<TResult1 | TResult2>

Staticreject

Type Parameters

Parameters

Returns Defer<T>

Staticresolve

Type Parameters

Parameters

Returns Defer<T>

Settings

On This Page

`Optional` `Readonly`name

`Readonly`promise

`Readonly`reject

`Readonly`resolve

`Static`reject

`Static`resolve