Code Monkey home page Code Monkey logo

redux-timer's Introduction

redux-timer npm versionnpm downloads

SetInterval middleware for Redux used to dispatch an action or function periodically.

Installation

npm install redux-timer

Usage

import { createStore, applyMiddleware } from 'redux';
import timerMiddleware from 'redux-timer';

const store = createStore(reducers, applyMiddleware(timerMiddleware));

How to start a timer

To start a timer, you have to dispatch an action with type START_TIMER with a payload of the following.

  • name (required) - String representing the name of the timer.
  • action (required) - String matching an action type or a Function that you would like to periodically execute.
  • interval (required) - Timer interval in milliseconds
  • runImmediately (optional) - Boolean to determine whether to fire the action immediately. This is set to true by default.

Using action as an action type

import { START_TIMER } from 'redux-timer';

export const startTimer = () => ({
  type: START_TIMER,
  payload: {
    name: 'exampleTimer',
    action: 'SOME_ACTION_TICK',
    interval: 1000,
    runImmediately: true
  }
});

Using action as a Function

import { START_TIMER } from 'redux-timer';

export const exampleAction = () => async dispatch => {
  dispatch({
    type: START_TIMER,
    payload: {
      name: 'exampleTimer',
      action: async () => {
        try {
          const response = await fetch('https://api.github.com');
          const data = await response.json();
          dispatch(setData(response.body.result));
        } catch (e) {
          // do something with this error
        }
      },
      interval: 5000,
      runImmediately: false
    }
  });
};

How to stop a timer

To stop a timer, you have to dispatch an action with type STOP_TIMER with a payload of the following.

  • name (required) - String representing the name of the timer
import { STOP_TIMER } from 'redux-timer';

export const stopTimer = () => ({
  type: STOP_TIMER,
  payload: {
    name: 'exampleTimer'
  }
});

TODO List

  • Need to add tests
  • Need to add CI/CD

redux-timer's People

Contributors

btav avatar elselabsuser avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.