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 pageType Alias: ResultMaybeAsync<T, E>Next pageFunction: andThen()

    #Type Alias: Success<T>

    Success<T> = object

    Defined in: result.ts:22

    Represents a successful result.

    #Example

    import { 
    import Result
    Result
    } from '@praha/byethrow';
    const
    const success: Result.Success<number>
    success
    :
    import Result
    Result
    .
    type Success<T> = {
        readonly type: "Success";
        readonly value: T;
    }

    Represents a successful result.

    @typeParamT - The type of the successful value.@example
    import { Result } from '@praha/byethrow';
    
    const success: Result.Success<number> = {
      type: 'Success',
      value: 42,
    };
    @categoryCore Types
    Success
    <number> = {
    type: "Success"
    type
    : 'Success',
    value: number
    value
    : 42,
    };

    #Type Parameters

    #T

    T

    The type of the successful value.

    #Properties

    #type

    readonly type: "Success"

    Defined in: result.ts:23


    #value

    readonly value: T

    Defined in: result.ts:24