@ryandur/sand
    Preparing search index...

    Type Alias Async<SUCCESS, FAILURE>

    The AsyncResult is something that Damien LeBerrigaud has introduced me to. I had the chance to work with him on a project that inspired me to write this lib. Together we collaborated on React Redux Starter to aid us in developing future projects with clients.

    The type allows you to work with a promise in the same way you would work with a Result, with some extra helpers.

    A factory for creating AsyncResult's

    type Async<SUCCESS, FAILURE> = {
        cancel: () => void;
        either: <NS, NF>(
            onSuccess: (value: SUCCESS) => Result.Async<NS, NF>,
            onFailure: (value: FAILURE) => Result.Async<NS, NF>,
        ) => Result.Async<NS, NF>;
        inspect: () => Promise<string>;
        map: <U>(f: (value: SUCCESS) => U) => Result.Async<U, FAILURE>;
        mBind: <U, NEW_FAILURE>(
            f: (value: SUCCESS) => Result.Async<U, NEW_FAILURE>,
        ) => Result.Async<U, FAILURE | NEW_FAILURE>;
        onCancel: (release: () => void) => Result.Async<SUCCESS, FAILURE>;
        onComplete: (
            f: (value: Result<SUCCESS, FAILURE>) => void,
        ) => Result.Async<SUCCESS, FAILURE>;
        onFailure: (f: (value: FAILURE) => void) => Result.Async<SUCCESS, FAILURE>;
        onPending: (
            f: (waiting: boolean) => void,
        ) => Result.Async<SUCCESS, FAILURE>;
        onSuccess: (f: (value: SUCCESS) => void) => Result.Async<SUCCESS, FAILURE>;
        or: <NEW_FAILURE, U>(
            f: (value: FAILURE) => Result.Async<U, NEW_FAILURE>,
        ) => Result.Async<SUCCESS | U, NEW_FAILURE>;
        orElse: <FALLBACK>(fallback: FALLBACK) => Promise<SUCCESS | FALLBACK>;
        orNull: () => Promise<SUCCESS | null>;
        value: Promise<Result<SUCCESS, FAILURE>>;
    }

    Type Parameters

    • SUCCESS
    • FAILURE
    Index
    cancel either inspect map mBind onCancel onComplete onFailure onPending onSuccess or orElse orNull value
    cancel: () => void
    either: <NS, NF>(
        onSuccess: (value: SUCCESS) => Result.Async<NS, NF>,
        onFailure: (value: FAILURE) => Result.Async<NS, NF>,
    ) => Result.Async<NS, NF>
    inspect: () => Promise<string>
    map: <U>(f: (value: SUCCESS) => U) => Result.Async<U, FAILURE>
    mBind: <U, NEW_FAILURE>(
        f: (value: SUCCESS) => Result.Async<U, NEW_FAILURE>,
    ) => Result.Async<U, FAILURE | NEW_FAILURE>
    onCancel: (release: () => void) => Result.Async<SUCCESS, FAILURE>

    onCancel: attaches work to free when the chain is canceled.

    The creator of the work is the only one who knows how to stop it — attach that knowledge here and cancel will call it. Attaching to an already-canceled chain releases immediately, so late work never leaks.

    onComplete: (
        f: (value: Result<SUCCESS, FAILURE>) => void,
    ) => Result.Async<SUCCESS, FAILURE>
    onFailure: (f: (value: FAILURE) => void) => Result.Async<SUCCESS, FAILURE>
    onPending: (f: (waiting: boolean) => void) => Result.Async<SUCCESS, FAILURE>

    onPending: A function that notifies the consuming function of the pending state.

    Upon invocation it will pass true to the consumer. Once the call has finished it will pass false to the consumer.

    Type Declaration

    The provided consumer gets called twice.

    onSuccess: (f: (value: SUCCESS) => void) => Result.Async<SUCCESS, FAILURE>
    or: <NEW_FAILURE, U>(
        f: (value: FAILURE) => Result.Async<U, NEW_FAILURE>,
    ) => Result.Async<SUCCESS | U, NEW_FAILURE>
    orElse: <FALLBACK>(fallback: FALLBACK) => Promise<SUCCESS | FALLBACK>
    orNull: () => Promise<SUCCESS | null>
    value: Promise<Result<SUCCESS, FAILURE>>

    Settings
    Member Visibility

    On This Page
    Properties