Class Ok<T>

constructor

• new Ok<T>(value: T): Ok<T>

  Type Parameters

  • T

  Parameters

  • value: T

  Returns Ok<T>

Readonlyvalue

[iterator]

• "[iterator]"(): Generator<never, T>

  Enables yield* res inside a result.gen body — the equivalent of Rust's ? operator.

  On Ok, yield* produces no yields and evaluates to the contained value. On Err, it yields the Err itself, which the surrounding result.gen / genSync / genAsync driver returns by reference (short-circuiting the rest of the body). Not meant to be iterated by anything other than those drivers.

  Returns Generator<never, T>

and

• and<R extends Result<OkContent<R>, ErrContent<R>>>(res: R): R

  Returns res if this result is Ok, otherwise returns this Err.

  res is evaluated eagerly; prefer andThen when it comes from a function call that should run only after Ok.

  Type Parameters

  • R extends Result<OkContent<R>, ErrContent<R>>

  Parameters

  • res: R

    Second result to return when this result is Ok.

  Returns R

  res on Ok, or this on Err.

  See

  Result::and

andThen

• andThen<R extends Result<OkContent<R>, ErrContent<R>>>(fn: (value: T) => R): R

  Calls fn if this result is Ok, otherwise returns this Err.

  Use to chain fallible steps that return another Result.

  Type Parameters

  • R extends Result<OkContent<R>, ErrContent<R>>

  Parameters

  • fn: (value: T) => R

    Called with the success value when this result is Ok.

  Returns R

  The Result from fn, or this on Err.

  See

  Result::and_then

expect

• expect(_message: string): T

  Returns the contained Ok value.

  Prefer narrowing (isOk / isErr) or non-throwing helpers (unwrapOr, unwrapOrElse) when the Err case is expected.

  Parameters

  • _message: string

  Returns T

  The success value.

  Throws

  When the result is Err.

  See

  Result::expect

inspect

• inspect(fn: (value: DeepReadonly<T>) => void): this

  Calls fn with the contained Ok value, then returns this unchanged.

  Callbacks receive DeepReadonly views (compile-time only; no runtime freeze).

  Parameters

  • fn: (value: DeepReadonly<T>) => void

    Side effect for the success value; not called on Err.

  Returns this

  this (for chaining).

  See

  Result::inspect

inspectErr

• inspectErr(_fn: unknown): this

  Calls fn with the contained Err value, then returns this unchanged.

  Parameters

  • _fn: unknown

  Returns this

  this (for chaining).

  See

  Result::inspect_err

isErr

• isErr(): this is never

  Returns true if the result is Err.

  Returns this is never

  See

  Result::is_err

isOk

• isOk(): this is Ok<T>

  Returns true if the result is Ok.

  Returns this is Ok<T>

  See

  Result::is_ok

map

• map<T2>(fn: (value: T) => T2): Ok<T2>

  Maps Result<T, E> to Result<U, E> by applying fn to the contained Ok value, leaving an Err untouched.

  Type Parameters

  • T2

  Parameters

  • fn: (value: T) => T2

    Transforms the success value.

  Returns Ok<T2>

  A new Result with the mapped Ok value, or the original Err.

  See

  Result::map

mapErr

• mapErr<_>(_fn: unknown): this

  Maps Result<T, E> to Result<T, F> by applying fn to the contained Err value, leaving an Ok untouched.

  Type Parameters

  • _

  Parameters

  • _fn: unknown

  Returns this

  A new Result with the mapped Err value, or the original Ok.

  See

  Result::map_err

mapOr

• mapOr<U1, U2>(_defaultValue: U1, fn: (value: T) => U2): U2

  Returns defaultValue if Err, or applies fn to the contained Ok value.

  Both arguments are evaluated eagerly; prefer mapOrElse when the fallback should run only on Err.

  Type Parameters

  • U1
  • U2

  Parameters

  • _defaultValue: U1
  • fn: (value: T) => U2

    Applied to the success value when this result is Ok.

  Returns U2

  See

  Result::map_or

mapOrElse

• mapOrElse<_, U2>(_defaultValue: unknown, fn: (value: T) => U2): U2

  Maps a Result to U by applying onErr to a contained Err value, or onOk to a contained Ok value.

  Type Parameters

  • _
  • U2

  Parameters

  • _defaultValue: unknown
  • fn: (value: T) => U2

  Returns U2

  See

  Result::map_or_else

or

• or(_res: unknown): this

  Returns res if this result is Err, otherwise returns this Ok.

  res is evaluated eagerly; prefer orElse for lazy fallbacks.

  Parameters

  • _res: unknown

  Returns this

  this on Ok, or res on Err.

  See

  Result::or

orElse

• orElse(_fn: unknown): this

  Calls fn if this result is Err, otherwise returns this Ok.

  Parameters

  • _fn: unknown

  Returns this

  The Result from fn, or this on Ok.

  See

  Result::or_else

unwrap

• unwrap(): T

  Returns the contained Ok value.

  Returns T

  The success value.

  Throws

  When the result is Err (message derived from the error).

  See

  Result::unwrap

unwrapErr

• unwrapErr(): never

  Returns the contained Err value.

  Returns never

  The error value.

  Throws

  When the result is Ok.

  See

  Result::unwrap_err

unwrapOr

• unwrapOr<T2>(_defaultValue: T2): T

  Returns the contained Ok value, or defaultValue if the result is Err.

  Type Parameters

  • T2

  Parameters

  • _defaultValue: T2

  Returns T

  T on Ok, otherwise defaultValue.

  See

  Result::unwrap_or

unwrapOrElse

• unwrapOrElse<_>(_fn: unknown): T

  Returns the contained Ok value, or computes it from the Err value.

  Type Parameters

  • _

  Parameters

  • _fn: unknown

  Returns T

  T on Ok, otherwise the value returned by fn.

  See

  Result::unwrap_or_else