Class Ok<T>

constructor

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

• Type Parameters

  • T

  Parameters

  • value: T

  Returns Ok<T>

Readonly value

extract

• extract<E>(): {
      error?: E;
      value?: T;
  }

• Extract the value or plain error from a Result.

  Type Parameters

  • E extends string | Error

    The type of the error value (must be string or instance of Error).

  Returns {
      error?: E;
      value?: T;
  }

  • An object with the value or error property set.

  • Optional error?: E

  • Optional value?: T

flatMap

• flatMap<U>(mapper): Result<U, never>

• Maps the success value to a new Result.

  Type Parameters

  • U

    The type of the success value of the new Result.

  Parameters

  • mapper: ((value) => Result<U, never>)

    A function to transform the success value.

    • • (value): Result<U, never>

      • Parameters

        • value: T

        Returns Result<U, never>

  Returns Result<U, never>

  • A new Result with the transformed value.

get

• get(): T

• Retrieves the value or throws an error if the result is an Err.

  Returns T

  • The success value.

  Throws

  The error value if the result is an Err.

map

• map<U>(mapper): Result<U, never>

• Maps the success value to a new value.

  Type Parameters

  • U

    The type of the new value.

  Parameters

  • mapper: ((value) => U)

    A function to transform the success value.

    • • (value): U

      • Parameters

        • value: T

        Returns U

  Returns Result<U, never>

  • A new Result with the transformed value.

toOptional

• toOptional(): Optional<T>

• Converts the Ok result to an Optional with the success value.

  Returns Optional<T>

  • An Optional containing the success value.

Static ok

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

• Creates an Ok result with the specified value.

  Type Parameters

  • T

    The type of the success value.

  Parameters

  • value: T

    The success value.

  Returns Ok<T>

  • An Ok result.