isOk API Reference

Signature

tsSignature

1
export function isOk<T, E>(result: Result<T, E>): result is Ok<T>;

tsImport

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

T

Success value type.

E

Expected error value type.

result

Result to inspect.

`true` when the result is `Ok`.

Return type

result is Ok<T>

Successful `Result` variant.

type

Explicit success-or-failure outcome used throughout Flow.

type

tsflow/core/result.ts:118-120

1
export function isOk<T, E>(result: Result<T, E>): result is Ok<T> {
2
  return result.ok;
3
}