redux-timer
SetInterval middleware for Redux used to dispatch an action or function periodically.
Installation
npm install redux-timer
Usage
;; const store = ;
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 aFunction
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 totrue
by default.
action
as an action type
Using ; const startTimer = type: START_TIMER payload: name: 'exampleTimer' action: 'SOME_ACTION_TICK' interval: 1000 runImmediately: true ;
action
as a Function
Using ; const exampleAction = async { ;};
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
; const stopTimer = type: STOP_TIMER payload: name: 'exampleTimer' ;
TODO List
- Need to add tests
- Need to add CI/CD