Interface: DebouncedFunc<FnArgumentsType, FnReturnType>
@sapphire/utilities.DebouncedFunc
Type parameters
| Name | Type |
|---|---|
FnArgumentsType | extends any[] |
FnReturnType | FnReturnType |
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
| Name | Type |
|---|---|
...args | FnArgumentsType |
Returns
undefined | FnReturnType
Defined in
Methods
cancel
▸ cancel(): void
Throw away any pending invocation of the debounced function.
Returns
void
Defined in
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