//#region src/index.d.ts interface DebounceOptions { /** Call the `fn` on the [leading edge of the timeout](https://css-tricks.com/debouncing-throttling-explained-examples/#article-header-id-1). Meaning immediately, instead of waiting for `wait` milliseconds. @default false */ readonly leading?: boolean; /** Call the `fn` on trailing edge with last used arguments. Result of call is from previous call. @default true */ readonly trailing?: boolean; } type DebouncedReturn = ((...args: ArgumentsT) => Promise) & { /** * Cancel pending function call */ cancel: () => void; /** * Immediately invoke pending function call */ flush: () => Promise | undefined; /** * Get pending function call */ isPending: () => boolean; }; /** Debounce functions @param fn - Promise-returning/async function to debounce. @param wait - Milliseconds to wait before calling `fn`. Default value is 25ms @returns A function that delays calling `fn` until after `wait` milliseconds have elapsed since the last time it was called. @example ``` import { debounce } from 'perfect-debounce'; const expensiveCall = async input => input; const debouncedFn = debounce(expensiveCall, 200); for (const number of [1, 2, 3]) { console.log(await debouncedFn(number)); } //=> 1 //=> 2 //=> 3 ``` */ declare function debounce(fn: (...args: ArgumentsT) => PromiseLike | ReturnT, wait?: number, options?: DebounceOptions): DebouncedReturn; //#endregion export { DebounceOptions, debounce };