useDebounceFn

Ensures that a function is only executed after a specified delay following the last invocation.

Installation

npm install @1hook/use-debounce-fn

Usage

import { useDebounceFn } from '@1hook/use-debounce-fn'

The useDebounceFn hook accepts a delay in milliseconds and returns a debounce function.

All calls are delayed until 1000ms have passed since the last invocation, then only the final call executes.

const { debounce } = useDebounceFn(1000)

debounce(() => console.log('Skipped'))
debounce(() => console.log('Executed after 1000ms'))

Override the default delay:

const { debounce } = useDebounceFn(1000)

debounce(() => console.log('Skipped'))
debounce(() => console.log('Executed after 500ms'), 500)

Cancel pending execution:

const { debounce, cancel, isPending } = useDebounceFn(1000)

isPending && cancel()

When the component unmounts, pending executions are automatically canceled.

API Reference