Skip to content
aq-ui
Back to HooksHook

Use Debounced Callback

Open-code aq-ui React hook for Use Debounced Callback.

Installation

pnpm dlx aq-ui@alpha add use-debounced-callback

API reference

Client module

Import the parts you need, then jump to an export for its contract.

View full source

Quick start

"use client"

import { useDebouncedCallback } from "@/hooks/use-debounced-callback"

DebouncedFunction

typeSource L9

Type contract for DebouncedFunction.

type DebouncedFunction<T extends AnyFunction> = ((...args: Parameters<T>) => void) & { … }

Members

NameType
cancel() => void
flush() => ReturnType<T> | undefined
pending() => boolean

useDebouncedCallback

functionSource L17

Open-code aq-ui React hook for Use Debounced Callback.

function useDebouncedCallback<T extends AnyFunction>(callback: T, delay = 250): DebouncedFunction<T>
Returns
DebouncedFunction<T>

Parameters

NameTypeDefault
callbackT—
delay?—250

Registry dependencies

use-latest

Files

  • hooks/use-debounced-callback.ts

Source