match API Reference

Signature

tsSignature

1
export function match<T, E, R>(
2
  result: Result<T, E>,
3
  handlers: {
4
    ok: (value: T) => R;
5
    err: (error: E) => R;
6
  },
7
): R;

Imports

tsImport

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

Type Parameters

T

Success value type.

E

Expected error value type.

R

Handler return type.

Parameters

result

Result<T, E>

Result to handle.

handlers

{ ok: (value: T) => R; err: (error: E) => R; }

Callbacks for the success and failure variants.

Returns

The value returned by the matching handler.

Return type

R

Details

`match` keeps success and error handling explicit without manual branching at the call site.

Examples

tsExample

1
const label = match(result, {
2
  ok: (user) => user.name,
3
  err: (error) => error.kind,
4
});

err

Re-exports core result helpers used by advanced record internals.

re-export

Re-exports core result helpers used by advanced record internals.

re-export

Result

Explicit success-or-failure outcome used throughout Flow.

type

Source

tsflow/core/result.ts:154-162

1
export function match<T, E, R>(
2
  result: Result<T, E>,
3
  handlers: {
4
    ok: (value: T) => R;
5
    err: (error: E) => R;
6
  },
7
): R {
8
  return result.ok ? handlers.ok(result.value) : handlers.err(result.error);
9
}

match