Overview
functionCore Result

err

Creates a branded failed result.

Signature

tsSignature
export function err<E>(error: E): Err<E>;

Imports

tsImport
import { err } from "@/lib/flow/core/result";
import { err } from "@/lib/flow";

Type Parameters

E

Expected error value type.

Parameters

error
E

Error value to carry in the failure variant.

Returns

A branded `Err` result.

Return type
Err<E>

Details

Use `err` for expected domain failures that should stay typed and recoverable by Flow helpers.

Examples

tsExample
const result = err({ kind: "not-found" });

Source

tsflow/core/result.ts:92-94
export function err<E>(error: E): Err<E> {
return brandResult({ ok: false, error });
}