Skip to main content

Function: isOk()

isOk<T, E>(result): result is { ok: true; value: T }

Defined in: src/types/result.ts:134

Type guard for success Results.

Type Parameters​

• T

Success value type

• E extends Error

Error type

Parameters​

result​

Result<T, E>

Result to check

Returns​

result is { ok: true; value: T }

True if Result is Ok, false if Err

Remarks​

This type guard narrows the Result type, allowing safe access to the value field in TypeScript.

Example​

const result = divide(10, 2);
if (isOk(result)) {
  // TypeScript knows result.value exists
  console.log(result.value);
}