Need help with redux-subscriber?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

ivantsov
205 Stars 13 Forks 12 Commits 2 Opened issues

Description

Subscribe to changes in any part of redux state

Services available

!
?

Need anything else?

Contributors list

No Data

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

  • https://github.com/ivantsov/yandex-mail-notifier-chrome - real app that uses
    redux-subscriber

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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.