Optional
addUse to support injecting additional fields into bindings
Optional
areIf specified, overrides the function used to compare error values.
If specified, overrides the function used to compare error values.
react-bindings
_.isEqual
, which can be globally overridden using react-bindings setAreEqual
react-bindings
_.isEqual
, which can be globally overridden using react-bindings setAreEqual
Optional
areIf specified, overrides the function used to compare values.
If specified, overrides the function used to compare values.
react-bindings
_.isEqual
, which can be globally overridden using react-bindings setAreEqual
react-bindings
_.isEqual
, which can be globally overridden using react-bindings setAreEqual
Optional
defaultThis 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.
Optional
depsOn a rerender, deps changes are treated like hard reset bindings changes.
Optional
detecttrue
– 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.false
– old and new values aren't compared and the error binding's underlying value will always be updated.true
Optional
detecttrue
– 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.false
– old and new values aren't compared and the value binding's underlying value will always be updated.true
Optional
hardIf any of these bindings change, the waitable will be hard reset
A technical, but human-readable ID, which isn't guaranteed to be unique
Optional
limitMSecThe duration to debounce/throttle for
0
Optional
limitThe limiter mode
'trailing'
Optional
limitThe type of limiter
'debounce'
Optional
lockedIf 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
Optional
lockedIf specified and the values of any of the specified bindings are truthy, the waitable is locked and the primary function cannot be run yet
Optional
onCalled 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)
Optional
onCalled each time this waitable is reset
Optional
onCalled each time setSuccess
is called (except if the call to setSuccess
is ignored, ex. due to a reset)
Optional
priorityThe priority
DEFAULT_PRIORITY
(0
)
Optional
queueThe queue
result of useDefaultQueue()
Optional
softIf any of these bindings change, the waitable will be soft reset
Generated using TypeDoc
Use to support injecting additional fields into bindings