resultFromSignal API Reference

Signature

tsSignature

1
export function resultFromSignal(signal: AbortSignal): Err<Cancelled>;

tsImport

1
import { resultFromSignal } from "@/lib/flow/core/runtime";
2
import { resultFromSignal } from "@/lib/flow";

signal

AbortSignal

Aborted signal whose reason should be preserved.

A failed result containing `Cancelled`.

Return type

Err<Cancelled>

Runtime error returned when execution is cancelled through an `AbortSignal`.

type

Failed `Result` variant.

type

tsflow/core/runtime.ts:269-271

1
export function resultFromSignal(signal: AbortSignal): Err<Cancelled> {
2
  return cancelled(signal.reason);
3
}