ghost-portal/packages/react-hooks/src/useDebounce.ts
2022-01-01 09:30:15 +02:00

28 lines
776 B
TypeScript

// Copyright 2017-2022 @polkadot/react-hooks authors & contributors
// SPDX-License-Identifier: Apache-2.0
import { useEffect, useState } from 'react';
import { useIsMountedRef } from './useIsMountedRef';
const DEFAULT_DELAY = 250;
// FIXE Due to generics, cannot use createNamedHook
export function useDebounce <T> (value: T, delay?: number): T {
const mountedRef = useIsMountedRef();
const [debouncedValue, setDebouncedValue] = useState(value);
useEffect((): () => void => {
const handler = setTimeout(() => {
mountedRef.current && setDebouncedValue(value);
}, delay || DEFAULT_DELAY);
// each time it renders, it clears
return (): void => {
clearTimeout(handler);
};
}, [delay, value, mountedRef]);
return debouncedValue;
}