import React, { useState, useEffect } from 'react'; /** * A hook to set a value * * @param {*} value - A value to "set" * @param {number} delay - The debounce delay for setting the value * @returns */ export default function useDebounce(value, delay) { const [debouncedValue, setDebouncedValue] = useState(value); useEffect( () => { // Set debouncedValue to value (passed in) after the specified delay const handler = setTimeout(() => { setDebouncedValue(value); }, delay); // Return a cleanup function that will be called every time useEffect is // re-called. useEffect will only be re-called if value changes (see the // inputs array below). // // This is how we prevent debouncedValue from changing if value is changed // within the delay period. Timeout gets cleared and restarted. // // To put it in context, if the user is typing within our app's search // box, we don't want the debouncedValue to update until they've stopped // typing for more than 500ms. return () => { clearTimeout(handler); }; }, // Only re-call effect if value changes // You could also add the "delay" var to inputs array if you need to be // able to change that dynamically. [value] ); return debouncedValue; }