succeed API Reference

Signature

tsSignature

1
export function succeed<O>(value: O): Behavior<unknown, O, never>;

tsImport

1
import { succeed } from "@/lib/flow/succeed";
2
import { succeed } from "@/lib/flow";

O

Output value type.

value

Value returned for every execution.

A behavior that ignores input and returns `Ok`.

Return type

Behavior<unknown, O, never>

Use `succeed` for constant branches, tests, and pipeline defaults.

tsExample

1
const cached = succeed({ source: "cache" });

Executable Flow workflow unit.

type

tsflow/succeed.ts:18-20

1
export function succeed<O>(value: O): Behavior<unknown, O, never> {
2
  return task<unknown, O, never>((_input, context) => context.ok(value));
3
}