useInterval

time

test coverage

Last changed: 26 days ago

Hook that makes and interval and returns controlling functions

import { useInterval } from '@siberiacancode/reactuse';

Usage

const { active, pause, resume, toggle } = useInterval(() => console.log('inside interval'), 2500);
// or
const { active, pause, resume, toggle } = useInterval(() => console.log('inside interval'), { interval: 2500 });

Demo

source

Api

Parameters

Name	Type	Default	Note
callback	() => void	-	Any callback function
interval?	number	1000	Time in milliseconds
options.immediately?	boolean	true	Start the interval immediately

Returns

UseIntervalReturn

Parameters

Name	Type	Default	Note
callback	() => void	-	Any callback function
options.interval?	number	1000	Time in milliseconds
options.immediately?	boolean	true	Start the interval immediately

Source

Source • Demo

Contributors

debabin

khmilevoi

hywax

pPitohu