Interface UseBindingSyncOptions

interface UseBindingSyncOptions {
    deps?: DependencyList;
    id?: string;
    limitMSec?: number;
    limitMode?: LimitMode;
    limitType?: LimitType;
    priority?: number;
    queue?: RunQueue;
}

Hierarchy (view full)

Properties

deps? id? limitMSec? limitMode? limitType? priority? queue?

Properties

Optional deps

deps?: DependencyList

On a rerender, deps changes are treated like bindings changes. That is, if they change between renders, the input change detection logic is run (using the areInputValuesEqual, detectInputChanges, and makeComparableInputValue values) using the limiter (see LimiterOptions).

Optional id

id?: string

A technical but human-readable ID

Optional limitMSec

limitMSec?: number

The duration to debounce/throttle for

Default Value

0

Optional limitMode

limitMode?: LimitMode

The limiter mode

Default Value

'trailing'

Optional limitType

limitType?: LimitType

The type of limiter

Default Value

'debounce'

Optional priority

priority?: number

The priority

Default Value

DEFAULT_PRIORITY (0)

Optional queue

queue?: RunQueue

The queue

Default Value

result of useDefaultQueue()

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc