Open-code aq-ui React hook for Use Throttled Callback.
aq-uipnpm dlx aq-ui@alpha add use-throttled-callbackImport the parts you need, then jump to an export for its contract.
"use client"
import { useThrottledCallback } from "@/hooks/use-throttled-callback"Type contract for ThrottledFunction.
type ThrottledFunction<T extends AnyFunction> = ((...args: Parameters<T>) => ReturnType<T> | undefined) & { … }| Name | Type |
|---|---|
cancel | () => void |
flush | () => ReturnType<T> | undefined |
pending | () => boolean |
Type contract for ThrottleOptions.
interface ThrottleOptions| Name | Type | Default |
|---|---|---|
leading? | boolean | true |
trailing? | boolean | true |
Open-code aq-ui React hook for Use Throttled Callback.
function useThrottledCallback<T extends AnyFunction>(callback: T, interval = 250, { leading = true, trailing = true }: ThrottleOptions = {}): ThrottledFunction<T>ThrottledFunction<T>| Name | Type | Default |
|---|---|---|
callback | T | — |
interval? | — | 250 |
options? | ThrottleOptions | {} |
use-latest