ok API Reference

Signature

tsSignature

1
export function ok<T>(value: T): Ok<T>;

tsImport

1
import { ok } from "@/lib/flow/core/result";
2
import { ok } from "@/lib/flow";

T

Success value type.

value

Value to carry in the success variant.

A branded `Ok` result.

Return type

Ok<T>

Branded results are recognized by `isResult`, which allows `task` callbacks to distinguish

explicit `Result` returns from plain successful values.

tsExample

1
const result = ok({ id: "user_1" });

Converts a structural result-like value into a branded Flow result.

function

Detects branded Flow results created by `ok`, `err`, or `from`.

function

Successful `Result` variant.

type

Explicit success-or-failure outcome used throughout Flow.

type

Creates a typed behavior from synchronous or asynchronous application code.

function

tsflow/core/result.ts:74-76

1
export function ok<T>(value: T): Ok<T> {
2
  return brandResult({ ok: true, value });
3
}