Skip to main content

Function: debounce()

debounce<FnArgumentsType, FnReturnType>(func: (...args: FnArgumentsType) => FnReturnType, options: DebounceSettings): DebouncedFunc<FnArgumentsType, FnReturnType>

Creates a debounced function that delays invoking func until after wait milliseconds have elapsed since the last time the debounced function was invoked. The debounced function comes with a cancel method to cancel delayed invocations and a flush method to immediately invoke them. Provide an options object to indicate that func should be invoked on the leading and/or trailing edge of the wait timeout. Subsequent calls to the debounced function return the result of the last func invocation.

Note: If leading and trailing options are true, func is invoked on the trailing edge of the timeout only if the the debounced function is invoked more than once during the wait timeout.

See David Corbacho’s article for details over the differences between _.debounce and _.throttle.

Type parameters

Type parameter
FnArgumentsType extends any[]
FnReturnType

Parameters

ParameterTypeDescription
func(...args: FnArgumentsType) => FnReturnTypeThe function to debounce.
optionsDebounceSettingsThe options object.

Returns

DebouncedFunc<FnArgumentsType, FnReturnType>

Returns the new debounced function.

Source

lib/debounce/debounce.ts:67