Interface UseWaitableArgs<SuccessT, FailureT, ExtraFieldsT>

interface UseWaitableArgs<SuccessT, FailureT, ExtraFieldsT> {
    addFields?: ((thisWaitable: Waitable<SuccessT, FailureT>) => ExtraFieldsT);
    areErrorsEqual?: ((a: any, b: any) => boolean);
    areValuesEqual?: ((a: any, b: any) => boolean);
    defaultValue?: "use-primary-function-if-unlocked" | UseWaitableDefaultValueProducer<SuccessT> | "use-primary-function";
    deps?: DependencyList;
    detectErrorChanges?: boolean;
    detectValueChanges?: boolean;
    hardResetBindings?: ReadonlyBinding<any> | BindingArrayDependencies;
    id: string;
    limitMode?: LimitMode;
    limitMSec?: number;
    limitType?: LimitType;
    lockedUntil?: ReadonlyBinding<any> | BindingArrayDependencies;
    lockedWhile?: ReadonlyBinding<any> | BindingArrayDependencies;
    onFailure?: UseWaitableOnFailureCallback<FailureT>;
    onReset?: UseWaitableOnResetCallback;
    onSuccess?: UseWaitableOnSuccessCallback<SuccessT>;
    priority?: number;
    queue?: RunQueue;
    softResetBindings?: ReadonlyBinding<any> | BindingArrayDependencies;
}

Type Parameters

  • SuccessT
  • FailureT = any
  • ExtraFieldsT extends object = EmptyObject

Hierarchy

  • LimiterOptions
    • UseWaitableArgs

Properties

addFields? areErrorsEqual? areValuesEqual? defaultValue? deps? detectErrorChanges? detectValueChanges? hardResetBindings? id limitMode? limitMSec? limitType? lockedUntil? lockedWhile? onFailure? onReset? onSuccess? priority? queue? softResetBindings?

Properties

OptionaladdFields

addFields?: ((thisWaitable: Waitable<SuccessT, FailureT>) => ExtraFieldsT)

Use to support injecting additional fields into bindings

OptionalareErrorsEqual

areErrorsEqual?: ((a: any, b: any) => boolean)

If specified, overrides the function used to compare error values.

See

react-bindings

Default Value

_.isEqual, which can be globally overridden using react-bindings setAreEqual

OptionalareValuesEqual

areValuesEqual?: ((a: any, b: any) => boolean)

If specified, overrides the function used to compare values.

See

react-bindings

Default Value

_.isEqual, which can be globally overridden using react-bindings setAreEqual

OptionaldefaultValue

defaultValue?: "use-primary-function-if-unlocked" | UseWaitableDefaultValueProducer<SuccessT> | "use-primary-function"

This can be used to generate a default value, which will be used to initialize the value and whenever this waitable is hard reset. You may alternatively, specify 'use-primary-function' or 'use-primary-function-if-unlocked', in which case the primary function will be called immediately on initialization or reset.

Optionaldeps

deps?: DependencyList

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

OptionaldetectErrorChanges

detectErrorChanges?: boolean
  • If true – areErrorsEqual is used to compare the old and new error values. If the values are equal, the error binding's underlying value won't be changed.
  • If false – old and new values aren't compared and the error binding's underlying value will always be updated.

Default Value

true

OptionaldetectValueChanges

detectValueChanges?: boolean
  • If true – areErrorsEqual is used to compare the old and new values. If the values are equal, the value binding's underlying value won't be changed.
  • If false – old and new values aren't compared and the value binding's underlying value will always be updated.

Default Value

true

OptionalhardResetBindings

hardResetBindings?: ReadonlyBinding<any> | BindingArrayDependencies

If any of these bindings change, the waitable will be hard reset

id

id: string

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

OptionallimitMode

limitMode?: LimitMode

The limiter mode

Default Value

'trailing'

OptionallimitMSec

limitMSec?: number

The duration to debounce/throttle for

Default Value

0

OptionallimitType

limitType?: LimitType

The type of limiter

Default Value

'debounce'

OptionallockedUntil

lockedUntil?: ReadonlyBinding<any> | BindingArrayDependencies

If specified and the values of any of the specified bindings are not truthy, the waitable is locked and the primary function cannot be run yet

OptionallockedWhile

lockedWhile?: ReadonlyBinding<any> | BindingArrayDependencies

If specified and the values of any of the specified bindings are truthy, the waitable is locked and the primary function cannot be run yet

OptionalonFailure

onFailure?: UseWaitableOnFailureCallback<FailureT>

Called each time setFailure is called (except if the call to setFailure is ignored, ex. due to a reset or when an error occurs when computing a default value)

OptionalonReset

onReset?: UseWaitableOnResetCallback

Called each time this waitable is reset

OptionalonSuccess

onSuccess?: UseWaitableOnSuccessCallback<SuccessT>

Called each time setSuccess is called (except if the call to setSuccess is ignored, ex. due to a reset)

Optionalpriority

priority?: number

The priority

Default Value

DEFAULT_PRIORITY (0)

Optionalqueue

queue?: RunQueue

The queue

Default Value

result of useDefaultQueue()

OptionalsoftResetBindings

softResetBindings?: ReadonlyBinding<any> | BindingArrayDependencies

If any of these bindings change, the waitable will be soft reset

Settings

Member Visibility

On This Page

Properties