Class Err<E>

constructor

• new Err<E>(error): Err<E>

• Type Parameters

  • E extends string | Error

  Parameters

  • error: E

  Returns Err<E>

Readonly error

extract

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

• Extract the value or plain error from a Result.

  Type Parameters

  • T

    The type of the success value.

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

  • An object with the value or error property set.

  • error: E

  • Optional value?: T

flatMap

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

• Maps the error value to a new Result.

  Type Parameters

  • F extends string | Error

    The type of the error value of the new Result.

  Parameters

  • mapper: ((error) => Result<never, F>)

    A function to transform the error value.

    • • (error): Result<never, F>

      • Parameters

        • error: E

        Returns Result<never, F>

  Returns Result<never, F>

  • A new Result with the transformed error value.

get

• get<T>(): T

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

  Type Parameters

  • T

  Returns T

  • The success value.

  Throws

  The error value if the result is an Err.

map

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

• Maps the error value to a new error value.

  Type Parameters

  • F extends string | Error

    The type of the new error value.

  Parameters

  • mapper: ((error) => F)

    A function to transform the error value.

    • • (error): F

      • Parameters

        • error: E

        Returns F

  Returns Result<never, F>

  • A new Result with the transformed error value.

throw

• throw(): E

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

  Returns E

  • The error value.

  Throws

  The success value if the result is an Ok.

toOptional

• toOptional(): Optional<E>

• Converts the Err result to an Optional with the error value.

  Returns Optional<E>

  • An Optional containing the error value.

Static error

• error<E>(error): Err<E>

• Creates an Err result with the specified error value.

  Type Parameters

  • E extends string | Error

    The type of the error value.

  Parameters

  • error: E

    The error value.

  Returns Err<E>

  • An Err result.