Variable ResultUtilsConst

Type declaration

• unwrap:function

  • unwrap<T, E extends Error>(result: Result<T, E>): T

    Unwraps a Success value or throws the error if Failure.

    Type Parameters

    • T
    • E extends Error

    Parameters

    • result: Result<T, E>

      The Result to unwrap

    Returns T

    The success value

    Throws

    The error if result is Failure

    Example

    const value = ResultUtils.unwrap(result); // throws if failure
    Copy

• unwrapOr:function

  • unwrapOr<T, E extends Error>(result: Result<T, E>, defaultValue: T): T

    Unwraps a Success value or returns a default value if Failure.

    Type Parameters

    • T
    • E extends Error

    Parameters

    • result: Result<T, E>

      The Result to unwrap
    • defaultValue: T

      The default value to return if Failure

    Returns T

    The success value or the default value

    Example

    const value = ResultUtils.unwrapOr(result, 0); // returns 0 if failure
    Copy

• isSuccess:function

  • isSuccess<T, E extends Error>(result: Result<T, E>): result is Success<T>

    Checks if a Result is a Success.

    Type Parameters

    • T
    • E extends Error

    Parameters

    • result: Result<T, E>

      The Result to check

    Returns result is Success<T>

    true if Success, false otherwise

• isFailure:function

  • isFailure<T, E extends Error>(result: Result<T, E>): result is Failure<E>

    Checks if a Result is a Failure.

    Type Parameters

    • T
    • E extends Error

    Parameters

    • result: Result<T, E>

      The Result to check

    Returns result is Failure<E>

    true if Failure, false otherwise