useDebounceValue | /deps/usehooks-ts.ts | netzo@0.5.70

function useDebounceValue

import { useDebounceValue } from "https://deno.land/x/netzo@0.5.70/deps/usehooks-ts.ts";

useDebounceValue<T>(

initialValue: T | (() => T),

delay: number,

options?: { leading?: boolean; maxWait?: number; trailing?: boolean; equalityFn?: (left: T, right: T) => boolean; },

): [T, DebouncedState<(value: T) => void>]

Returns a debounced version of the provided value, along with a function to update it.

Examples

const [debouncedValue, updateDebouncedValue] = useDebounceValue(inputValue, 500, { leading: true });

initialValue: T | (() => T)

delay: number

optional

options: { leading?: boolean; maxWait?: number; trailing?: boolean; equalityFn?: (left: T, right: T) => boolean; }

[T, DebouncedState<(value: T) => void>]

An array containing the debounced value and the function to update it.