Cancelled API Reference

Signature

tsSignature

1
export type Cancelled = {
2
  kind: "cancelled";
3
  reason?: unknown;
4
};

tsImport

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

Cancellation is cooperative. Flow helpers check the signal before and after async work and pass

linked signals to child behaviors where appropriate.

Creates a cancellation result.

function

tsflow/core/runtime.ts:9-12

1
export type Cancelled = {
2
  kind: "cancelled";
3
  reason?: unknown;
4
};