useInterval

About

setInterval hook for React.

Installation

npm install --save rooks

Importing the hook

import { useInterval } from 'rooks';

Usage

function reducer(state, action) {
  switch (action.type) {
    case 'increment':
      return { count: state.count + 1 };
    default:
      return state;
  }
}

function Demo() {
  const [value, dispatcher] = useReducer(reducer, { count: 0 });

  function increment() {
    dispatcher({
      type: 'increment',
    });
  }

  const { start, stop } = useInterval(() => {
    increment();
  }, 1000);

  return (
    <>
      <p>value is {value.count}</p>
      <button onClick={start}>Start</button>
      <button onClick={stop}>Stop</button>
    </>
  );
}
render(<Demo />);

Arguments

Argument	Type	Description	Default value
callback	function	Function be invoked after each interval duration	undefined
intervalDuration	number	Duration in milliseconds after which callback is invoked	undefined
startImmediate	boolean	Should the timer start immediately or no	false

Returned Object

Returned object attributes	Type	Description
start	function	Start the interval
stop	function	Stop the interval
intervalId	intervalId	IntervalId of the interval

Codesandbox Example

Basic usage

Join Bhargav's discord server

You can click on the floating discord icon at the bottom right of the screen and talk to us in our server.