Delayable

Properties

isDelayable: Boolean= truereadonly

Identifies an object as an instance of Delayable class, or subclass thereof.

isDelayable: Boolean= truereadonlystatic

Identifies an object as an instance of Delayable class, or subclass thereof.

Functions

Creates a function which will execute once, on the next animation frame. However many time it is called in one event run, it will only be scheduled to run once.

Parameter	Type	Description
`fn`	function \| String	The function to call, or name of function in this object to call.
`args`	Object[]	The argument list to append to those passed to the function.
`thisObj`	Object	`this` reference for the function.
`cancelOutstanding`	Boolean	Cancel any outstanding queued invocation upon call.

Returns: function -

A function which can be called multiple times, and will only execute once on the next animation frame

Typedefs

DelayableConfig

Configuration options available when defining a delayable function.

Parameter	Type	Description
`type`	buffer \| raf \| idle \| throttle	Type of delay to use. `raf` is short for `requestAnimationFrame`, 'idle' for `requestIdleCallback` (not supported in Safari)
`delay`	Number	Number of milliseconds to wait before (buffer) or after (throttle) calling the underlying method. A value of 0 is equivalent to setting `immediate: true`.
`immediate`	Boolean	Set to `true` to call immediately (effectively disabling the buffer/throttle)
`cancelOutstanding`	Boolean	Set to `true` to cancel any pending animation frame requests and schedule a new one on each call.