Type Alias: Result<TValue, TError>

Result<TValue, TError> = Ok<TValue, TError> | Err<TValue, TError>

Defined in: src/types/index.ts:70

Represents a result that can be either success (Ok) or failure (Err).

Type Parameters

Type Parameter	Description
TValue	Success value type
TError	Error value type

See

AsyncResult - for async version

Example

function divide(a: number, b: number): Result<number, string> {
  if (b === 0) return Result.err('Division by zero')

  return Result.ok(a / b)
}

divide(10, 2) // => Ok(5)
divide(10, 0) // => Err("Division by zero")