/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library 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 Lesser General Public License for more
* details.
*/
import {useCallback} from 'react';
import useIsMounted from './useIsMounted.es';
/**
* Hook for scheduling a repeating function call with the specified
* interval (in milliseconds).
*/
export default function useInterval() {
const isMounted = useIsMounted();
return useCallback(
function schedule(fn, ms) {
const handle = setInterval(() => {
if (isMounted()) {
fn();
} else {
clearInterval(handle);
}
}, ms);
return () => clearInterval(handle);
},
[isMounted]
);
}