useDebounceEffect
A hook to debounce an effect
Loading...
Installation
npx shadcn@latest add @shadcnhooks/use-debounce-effectAPI
interface DebounceOptions {
/**
* An optional AbortSignal to cancel the debounced function.
*/
signal?: AbortSignal
/**
* An optional array specifying whether the function should be invoked on the leading edge, trailing edge, or both.
* If `edges` includes "leading", the function will be invoked at the start of the delay period.
* If `edges` includes "trailing", the function will be invoked at the end of the delay period.
* If both "leading" and "trailing" are included, the function will be invoked at both the start and end of the delay period.
* @default ["trailing"]
*/
edges?: Array<'leading' | 'trailing'>
}
/**
* A hook to debounce an effect
* @param effect - The effect to debounce
* @param deps - The dependencies to debounce the effect on
* @param debounceMs - The debounce time in milliseconds default to 1000
* @param options - The options for the debounce effect
* @returns The debounced effect
*/
export function useDebounceEffect(
effect: EffectCallback,
deps: DependencyList,
debounceMs?: number,
options?: DebounceOptions,
): voidCredits
Last updated on