Aborted

Aborted: object

Defined in: Core/Aborted.ts:24

Type Declaration

is

is: (value) => value is Aborted

Narrows any { kind } discriminated value to Aborted.

Parameters

value

kind

string

Returns

value is Aborted

See

Aborted.make to construct an Aborted outcome.

Example

if (Aborted.is(error)) {
  logCancellation(error.reason);
}

make

make: (reason?) => Aborted

Creates an Aborted outcome from a cancellation reason.

Engines call this from their own AbortSignal listeners. Use it directly when a transform or a test needs to represent a cancelled run without a live signal.

Parameters

reason?

unknown

Returns

Aborted

See

Aborted.is to check whether a settled value is a cancellation.

Example

Aborted.make("user navigated away"); // { kind: "Aborted", reason: "user navigated away" }