Class Ok<T>

constructor

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

  Creates a new Ok instance containing a successful value.

  Type Parameters

  • T

    The type of the successful value

  Parameters

  • value: T

    The successful value

  Returns Ok<T>

Readonlyvalue

isOk

• isOk(): this is Ok<T>

  Type guard to check if this Result is an Ok. Always returns true for Ok instances.

  Returns this is Ok<T>

  true for Ok instances

  Example

  const result: Result<number> = ok(5);
  if (result.isOk()) {
    // TypeScript knows result.value exists here
    console.log(result.value);
  }
  Copy

map

• map<O>(fn: (value: T) => O): Result<O>

  Transforms the successful value using the provided function. If this is an Ok, applies the function to the value and wraps the result in a new Ok.

  Type Parameters

  • O

    The type of the transformed value

  Parameters

  • fn: (value: T) => O

    The function to transform the value

  Returns Result<O>

  A new Result containing the transformed value

  Example

  const result: Result<number> = ok(5);
  const doubled: Result<number> = result.map(x => x * 2);
  // doubled = Ok(10)
  Copy