@rooks/use-interval NPM | npm.io

4.11.2 • Published 5 years ago

Install

Weekly downloads

2,383

License

MIT

Repository

Last release

5 years ago

@rooks/use-interval

Note: Future updates to this package have moved to the main package rooks. All hooks now reside in a single package which you can install using

npm install rooks

or

yarn add rooks

Rooks is completely treeshakeable and if you use only 1 of the 50+ hooks in the package, only that hook will be bundled with your code. Your bundle will only contain the hooks that you need. Cheers!

TitleCard

npm.io npm.io npm.io npm.io

About

setInterval hook for React.

Installation

npm install --save @rooks/use-interval

Importing the hook

import useInterval from "@rooks/use-interval"

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

use react-hooks.org react rooks hooks setInterval interval

@everything-registry/sub-chunk-789 headless-carousel @cs-chatbots/webchat-ui

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

4.0.0-canary.23

5 years ago

4.0.0-canary.22

5 years ago

5 years ago

4.0.0-canary.20

5 years ago

4.0.0-canary.17

5 years ago

4.0.0-canary.19

5 years ago

4.0.0-canary.16

5 years ago

4.0.0-canary.14

5 years ago

4.0.0-canary.13

5 years ago

4.0.0-canary.10

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

6 years ago

6 years ago

6 years ago

6 years ago

3.5.1-canary.20

6 years ago

6 years ago

6 years ago

3.4.4-71d48a96.0

6 years ago

3.4.4-e1839b43.0

6 years ago

3.4.4-a9fb8da1.0

6 years ago

6 years ago

3.4.4-ca7e506a.0

6 years ago

3.4.4-0b6223c4.0

6 years ago

3.4.3-cfbe4783.0

6 years ago

3.4.3-f130c101.0

6 years ago

3.4.3-53abf21e.0

6 years ago

3.4.3-695b2acc.0

6 years ago

3.4.3-bb90b83d.0

6 years ago

3.4.3-5f1a38fa.0

6 years ago

3.4.3-20c504bd.0

6 years ago

6 years ago

3.4.3-efa33040.0

6 years ago

3.4.2-1963d180.0

6 years ago

3.4.2-0668aca8.0

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

7 years ago

7 years ago

7 years ago

7 years ago

3.0.0-3.0.0-beta.2.0

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago