redux-subscriber
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/redux-subscriber package

1.1.0 • Public • Published

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.

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 1.1.0
    3,047
    • latest

Version History

  • Version
    Downloads (Last 7 Days)
    • Published
  • 1.1.0
    3,047
  • 1.0.0
    1

Package Sidebar

Install

npm i redux-subscriber

Weekly Downloads

3,048

Version

1.1.0

License

MIT

Last publish

Collaborators

  • ivantsov