Interface UseWaitableCallbackOptions<ArgsT, DependenciesT>

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

Type Parameters

Hierarchy (view full)

Properties

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

Properties

OptionalcontinueWaitingOnFailure

continueWaitingOnFailure?: TypeOrDeferredType<boolean>

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

Default Value

false

OptionalcontinueWaitingOnReset

continueWaitingOnReset?: TypeOrDeferredType<boolean>

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

Default Value

true

Optionaldeps

deps?: DependencyList

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

Optionalid

id?: string

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

OptionalifNotReady

ifNotReady?: IfNotReadyCallback<ArgsT, DependenciesT>

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

OptionaltimeoutMSec

timeoutMSec?: number

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

Default Value

unlimited

Settings

Member Visibility

On This Page

Properties