react-waitables
    Preparing search index...

    Interface UseWaitableCallbackOptions<ArgsT, DependenciesT>

    interface UseWaitableCallbackOptions<
        ArgsT extends any[],
        DependenciesT extends WaitableDependencies,
    > {
        continueWaitingOnFailure?: TypeOrDeferredType<boolean>;
        continueWaitingOnReset?: TypeOrDeferredType<boolean>;
        deps?: DependencyList;
        id?: string;
        ifNotReady?: IfNotReadyCallback<ArgsT, DependenciesT>;
        timeoutMSec?: number;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    continueWaitingOnFailure? continueWaitingOnReset? deps? id? ifNotReady? timeoutMSec?

    Properties

    continueWaitingOnFailure?: TypeOrDeferredType<boolean>

    Checked if a failure occurs while waiting. If true, continues waiting. Otherwise, stops waiting and the wait function returns 'failure'

    false

    continueWaitingOnReset?: TypeOrDeferredType<boolean>

    Checked if a reset occurs while waiting. If true, continues waiting. Otherwise, stops waiting and the wait function returns 'reset'

    true

    deps?: DependencyList

    On a rerender, deps changes are treated like hard reset bindings changes.

    id?: string

    A technical, but human-readable ID, which isn't guaranteed to be unique

    ifNotReady?: IfNotReadyCallback<ArgsT, DependenciesT>

    If call is called when not ready, this will be called instead of ifReady

    timeoutMSec?: number

    If specified, the interval after which the wait function will resolve with 'timeout' if the waitable is still incomplete.

    unlimited

    Settings

    Member Visibility

    On This Page

    Properties