@health-samurai/aidbox-client
    Preparing search index...

    Type Alias Err<E>

    type Err<E> = {
        ok: false;
        value: E;
        isOk: () => this is Ok<never>;
        isErr: () => this is Err<E>;
        map: <U>(f: (value: never) => U) => Result<never, E>;
        mapErr: <U>(f: (value: E) => U) => Result<never, U>;
    }

    Type Parameters

    • E
    Index

    Properties

    ok: false
    value: E
    isOk: () => this is Ok<never>

    Check if Result is Ok.

    isErr: () => this is Err<E>

    Check if Result is Err.

    map: <U>(f: (value: never) => U) => Result<never, E>

    Map Result's success value to a new value by providing a transformation function.

    Returns a new Result<UpdatedType, ErrorType>:

    const x = Ok<number>(42); // Result<number, never>
    const y = x.map<string>((x: number) => x.toString()) // Result<string, never>

    Does nothing if the Result is not Ok:

    const x = Err<number>(42); // Result<never, number>
    const y = x.map<string>((x: number) => x.toString()) // Result<never, number>
    mapErr: <U>(f: (value: E) => U) => Result<never, U>

    Map Result's error value to a new value by providing a transformation function.

    Returns a new Result<SuccessType, NewErrorType>:

    const x = Err<number>(42); // Result<never, number>
    const y = x.mapErr<string>((x: number) => x.toString()) // Result<never, string>

    Does nothing if the Result is not Err:

    const x = Ok<number>(42); // Result<number, never>
    const y = x.mapErr<string>((x: number) => x.toString()) // Result<number, never>