Skip to main content

Interface: DebouncedFunc<FnArgumentsType, FnReturnType>

@sapphire/utilities.DebouncedFunc

Type parameters​

NameType
FnArgumentsTypeextends any[]
FnReturnTypeFnReturnType

Callable​

DebouncedFunc​

▸ DebouncedFunc(...args): undefined | FnReturnType

Call the original function, but applying the debounce rules.

If the debounced function can be run immediately, this calls it and returns its return value.

Otherwise, it returns the return value of the last invocation, or undefined if the debounced function was not invoked yet.

Parameters​

NameType
...argsFnArgumentsType

Returns​

undefined | FnReturnType

Defined in​

projects/utilities/packages/utilities/src/lib/debounce/debounce.ts:34

Methods​

cancel​

▸ cancel(): void

Throw away any pending invocation of the debounced function.

Returns​

void

Defined in​

projects/utilities/packages/utilities/src/lib/debounce/debounce.ts:39

flush​

▸ flush(): undefined | FnReturnType

If there is a pending invocation of the debounced function, invoke it immediately and return its return value.

Otherwise, return the value from the last invocation, or undefined if the debounced function was never invoked.

Returns​

undefined | FnReturnType

Defined in​

projects/utilities/packages/utilities/src/lib/debounce/debounce.ts:48