Variable: ok

ok: <TValue>(value) => Ok<TValue, never>

Defined in: src/index.ts:61

Creates a successful Result containing the provided value.

Returns an Ok wrapping the given value.

Type Parameters

Type Parameter	Description
TValue	Success value type.

Parameters

Parameter	Type	Description
value	TValue	Value to wrap.

Returns

Ok<TValue, never>

See

err - Create a failed result.

Examples

Result.ok(42)      // => Ok(42)
Result.ok('hello') // => Ok('hello')

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

interface User { id: number; name: string }
const user: User = { id: 1, name: 'John' }

Result.ok(user)
// => Ok({ id: 1, name: 'John' })