1.0.0 • Published 3 years ago

use-timeout-mock-interval v1.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
3 years ago

use-timeout-mock-interval

A custom React Hook that provides a declarative setTimeout mock setInterval called useTimeoutMockInterval.

NPM

Installation

$ npm i use-timeout-mock-interval

or

$ yarn add use-timeout-mock-interval

Usage

useTimeoutMockInterval(fn, delay);

Parameters

Here are the parameters that you can use.

ParameterDescription
fnA function that will be called every delay milliseconds.
delayA number representing the delay in msecs. Set to null to "pause" the interval.

Example

import React, { useState } from 'react';
import useTimeoutMockInterval from 'use-timeout-mock-interval';

const Counter = ({ delay = 1000 }) => {
  const [count, setCount] = useState(0);

  useTimeoutMockInterval(() => {
    setCount((currentCount) => currentCount + 1);
  }, delay);

  return <h1>{count}</h1>;
};

export default Counter;

License

MIT Licensed