useInterval

setInterval reactified, with synchronization support.

Installation

npm install @1hook/use-interval

import { useInterval } from '@1hook/use-interval'

Set an interval:

const { cancel, reset, isPending } = useInterval(() => {
  console.log('Hello')
}, 1000)

Pause the interval by setting the delay to null:

useInterval(() => console.log('Hello'), null)

Execute immediately by setting the leading option to true:

useInterval(() => console.log('Hello'), 1000, { leading: true })

Synchronize all intervals that share the same delay using the sync option:

useInterval(() => console.log('Hello'), 1000, { sync: true })

Options for the useInterval hook (3rd argument).

Prop	Type	Default
`sync?`	`boolean`	`false`
`leading?`	`boolean`	`false`

Return value of the useInterval hook.