• English
  • Type Alias: Success<T>

    Success<T> = object

    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"


    value

    readonly value: T