48 lines
1.6 KiB
TypeScript
48 lines
1.6 KiB
TypeScript
/**
|
|
* Licensed to the Apache Software Foundation (ASF) under one
|
|
* or more contributor license agreements. See the NOTICE file
|
|
* distributed with this work for additional information
|
|
* regarding copyright ownership. The ASF licenses this file
|
|
* to you under the Apache License, Version 2.0 (the
|
|
* "License"); you may not use this file except in compliance
|
|
* with the License. You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing,
|
|
* software distributed under the License is distributed on an
|
|
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
* KIND, either express or implied. See the License for the
|
|
* specific language governing permissions and limitations
|
|
* under the License.
|
|
*/
|
|
import { useEffect, useRef } from 'react';
|
|
|
|
/*
|
|
* Functional components and setTimeout with useState do not play well
|
|
* and the setTimeout callback typically has stale state from a closure
|
|
* The useInterval function solves this issue.
|
|
* more info: https://overreacted.io/making-setinterval-declarative-with-react-hooks/
|
|
*/
|
|
function useInterval(callback: Function, delay: number | null): void {
|
|
const savedCallback = useRef<Function>(callback);
|
|
// Remember the latest function.
|
|
useEffect(() => {
|
|
savedCallback.current = callback;
|
|
}, [callback]);
|
|
|
|
// Set up the interval.
|
|
useEffect(() => {
|
|
function tick() {
|
|
savedCallback?.current?.();
|
|
}
|
|
if (delay !== null) {
|
|
const id = setInterval(tick, delay);
|
|
return () => clearInterval(id);
|
|
}
|
|
return () => {};
|
|
}, [delay]);
|
|
}
|
|
|
|
export default useInterval;
|