logo
byethrow
  • Guide
  • Examples
  • API Reference
    @praha/byethrow
    Modules
    Result
    Types
    Type Alias: Failure<E>
    Type Alias: InferFailure<T>
    Type Alias: InferSuccess<T>
    Type Alias: Result<T, E>
    Type Alias: ResultAsync<T, E>
    Type Alias: ResultFor<R, T, E>
    Type Alias: ResultMaybeAsync<T, E>
    Type Alias: Success<T>
    Functions
    Function: andThen()
    Function: andThrough()
    Function: assertFailure()
    Function: assertSuccess()
    Function: bind()
    Function: collect()
    Function: do()
    Function: fail()
    Function: inspect()
    Function: inspectError()
    Function: isFailure()
    Function: isResult()
    Function: isSuccess()
    Function: map()
    Function: mapError()
    Function: orElse()
    Function: parse()
    Function: pipe()
    Function: sequence()
    Function: succeed()
    Function: try()
    Function: unwrap()
    Function: unwrapError()
    📝 Edit this page

    Last Updated:

    Previous pageResultNext pageType Alias: InferFailure<T>

    #Type Alias: Failure<E>

    Failure<E> = object

    Defined in: result.ts:44

    Represents a failed result.

    #Example

    import { 
    import Result
    Result
    } from '@praha/byethrow';
    const
    const failure: Result.Failure<string>
    failure
    :
    import Result
    Result
    .
    type Failure<E> = {
        readonly type: "Failure";
        readonly error: E;
    }

    Represents a failed result.

    @typeParamE - The type of the error.@example
    import { Result } from '@praha/byethrow';
    
    const failure: Result.Failure<string> = {
      type: 'Failure',
      error: 'Something went wrong',
    };
    @categoryCore Types
    Failure
    <string> = {
    type: "Failure"
    type
    : 'Failure',
    error: string
    error
    : 'Something went wrong',
    };

    #Type Parameters

    #E

    E

    The type of the error.

    #Properties

    #error

    readonly error: E

    Defined in: result.ts:46


    #type

    readonly type: "Failure"

    Defined in: result.ts:45