Awesome Open Source
Awesome Open Source

redux-subscriber

Build Status codecov npm version

This package allows you to subscribe to changes in any part of Redux state.

Installation

npm install redux-subscriber --save

Usage

store.js

import {createStore} from 'redux';
import initSubscriber from 'redux-subscriber';

const store = createStore(...);

// "initSubscriber" returns "subscribe" function, so you can use it
const subscribe = initSubscriber(store);

somewhere-else.js

// or you can just import "subscribe" function from the package
import {subscribe} from 'redux-subscriber';

const unsubscribe = subscribe('user.messages.count', state => {
  // do something
});

// if you want to stop listening to changes
unsubscribe();

Examples

API

initSubscriber(store) (default export) - initialize redux-subscriber, so after that you can use subscribe method.

Options

  • store - instance of Redux store.

Returns subscribe function.

subscribe(key, callbackFunction) - subscribe callbackFunction to changes.

Options

  • key - string which specified the part of state (e.g. user.message.count) to listen to.
  • callbackFunction - function which will be called when the part of state has changed. New state is passed as a parameter.

Returns unsubscribe function which can be called to unsubscribe from changes.


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
javascript (68,032
react (5,155
redux (1,150
store (66
watch (56

Find Open Source By Browsing 7,000 Topics Across 59 Categories