@neo4j-ndl/react
Version:
React implementation of Neo4j Design System
41 lines • 1.61 kB
TypeScript
/**
*
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [http://neo4j.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
export type DebounceOptions = {
leading?: boolean;
trailing?: boolean;
maxWait?: number;
};
type GenericFunction = (...args: never[]) => unknown;
type DebouncedState<T extends GenericFunction> = ((...args: Parameters<T>) => ReturnType<T> | undefined) & {
cancel: () => void;
flush: () => ReturnType<T> | undefined;
isPending: () => boolean;
};
/**
* Local override for usehooks-ts useDebounceCallback.
*
* This keeps one debounced function instance across rerenders (unless delay/options change)
* while always calling the latest callback. It avoids resetting debounce timing when
* inline callbacks are recreated every render.
*/
export declare function useDebounceCallback<T extends GenericFunction>(func: T, delay?: number, options?: DebounceOptions): DebouncedState<T>;
export {};
//# sourceMappingURL=index.d.ts.map