npmpackage.info

Gathering detailed insights and metrics for redux-state-sync-per-instance

redux-state-sync-per-instance - 3.1.5 | npmpackage.info

redux-state-sync-per-instance

A lightweight middleware to sync your redux state across browser tabs

3.1.5

238

MIT

JavaScript

5.18 kB

2,664 2.1

Installations

npm install redux-state-sync-per-instance

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

10.16.3

NPM Version

6.14.2 Score

75.2

Supply Chain

98.4

Quality

73.6

Maintenance

100

Vulnerability

98.2

License

Pull Requests

Open

43

Total

130

Closed

71

Merged

16

Issues

Open

21

Total

45

Closed

24

Releases

Unable to fetch releases

Languages

JavaScript

HTML

CSS

Shell

JavaScript (92.12%)

HTML (6.1%)

CSS (1.69%)

Shell (0.1%)

Developer

AOHUA

Download Statistics

Total Downloads

2,664

Last Day

Last Week

Last Month

Last Year

1,187

GitHub Statistics

MIT License

238 Stars

122 Commits

27 Forks

4 Watchers

41 Branches

11 Contributors

Updated on Apr 10, 2025

Bundle Size

16.22 kB

Minified

5.18 kB

Minified + Gzipped

Bundlephobia

Maintainers

View All 11 Contributors

Package Meta Information

Latest Version

3.1.5

Package Id

redux-state-sync-per-instance@3.1.5

Unpacked Size

2.13 MB

Size

914.12 kB

File Count

NPM Version

6.14.2

Node Version

10.16.3

Total Downloads

Cumulative downloads

Total Downloads

2,664

Redux-State-Sync 3

A lightweight middleware to sync your redux state across browser tabs. It will listen to the Broadcast Channel and dispatch exactly the same actions dispatched in other tabs to keep the redux state in sync.

Why Redux-State-Sync?

It syncs your redux store across tabs with very minimal configuration.

Thanks to BroadcastChannel, we now have a more efficient way to communicate between tabs instead of using any type of local storage. However, Not all the browsers support BroadcastChannel API for now. So I used pubkey's BroadcastChannel to find the best way to communicate between tabs for redux-state-sync. pubkey's BroadcastChannel will make sure that the communication between tabs always works.

How to install

Install with npm.

npm install --save redux-state-sync

Install with yarn

yarn add redux-state-sync

TypeScript support

Install with npm.

npm install --save-dev @types/redux-state-sync

Install with yarn

yarn add --dev @types/redux-state-sync

Types are defined here

Before you use

Please take note that BroadcastChannel can only send data that is supported by the structured clone algorithm (Strings, Objects, Arrays, Blobs, ArrayBuffer, Map), so you need to make sure that the actions that you wanna send to other tabs doesn't include any functions in the payload.

If you are using redux-persist, you may need to blacklist some of the actions that is triggered by redux-persist. e.g. persist/PERSIST, persist/REHYDRATE, etc.

How to use

Create the state sync middleware with config:

1import { createStore, applyMiddleware } from 'redux';
2import { createStateSyncMiddleware, initMessageListener } from 'redux-state-sync';
3
4const config = {
5    // TOGGLE_TODO will not be triggered in other tabs
6    blacklist: ['TOGGLE_TODO'],
7};
8const middlewares = [createStateSyncMiddleware(config)];
9const store = createStore(rootReducer, {}, applyMiddleware(...middlewares));
10// this is used to pass store.dispatch to the message listener
11initMessageListener(store);

initMessageListener is a new function to fix the bug that if the other tab not triggering any action on first load, it cannot receive any messages.

Init new tabs with existing state:

Use initStateWithPrevTab to get existing state from other tabs

1import { createStore, applyMiddleware } from 'redux';
2import { createStateSyncMiddleware, initStateWithPrevTab } from 'redux-state-sync';
3
4const config = {
5    // TOGGLE_TODO will not be triggered in other tabs
6    blacklist: ['TOGGLE_TODO'],
7};
8const middlewares = [createStateSyncMiddleware(config)];
9const store = createStore(rootReducer, {}, applyMiddleware(...middlewares));
10// init state with other tabs
11initStateWithPrevTab(store);
12// initMessageListener(store);

Note: if you are already using initStateWithPrevTab, you don't need to initMessageListener anymore.

Wrap your root reducer with withReduxStateSync

1import { withReduxStateSync } from 'redux-state-sync';
2const rootReducer = combineReducers({
3    todos,
4    visibilityFilter,
5});
6
7export default withReduxStateSync(rootReducer);

Note: ignore this if you are using `redux-persist`, because you will always inite your app with the state in the storage. However, if you don't want to persist the state in the storage and still want to init new tabs with opening tabs' state, you can follow the example above.

Config

channel

Unique name for Broadcast Channel

type: String

default: "redux_state_sync"

1const config = {
2    channel: 'my_broadcast_channel',
3};
4const middlewares = [createStateSyncMiddleware(config)];

predicate

A function to let you filter the actions as you wanted.

Note: Since version 3.0 the function receives the action itself and not only the action type.

type: Function

default: null

1const config = {
2    // All actions will be triggered in other tabs except 'TOGGLE_TODO'
3    predicate: action => action.type !== 'TOGGLE_TODO',
4};
5const middlewares = [createStateSyncMiddleware(config)];

blacklist

A list of action types that you don't want to be triggered in other tabs.

type: ArrayOf(<String>)

default: []

1const config = {
2    // All actions will be triggered in other tabs except 'TOGGLE_TODO'
3    blacklist: ['TOGGLE_TODO'],
4};
5const middlewares = [createStateSyncMiddleware(config)];

whitelist

Only actions in this list will be triggered in other tabs.

type: ArrayOf(<String>)

default: []

1const config = {
2    // Only 'TOGGLE_TODO' will be triggered in other tabs
3    whitelist: ['TOGGLE_TODO'],
4};
5const middlewares = [createStateSyncMiddleware(config)];

Warning: You should only use one of the option to filter your actions. if you have all 3 options predicate, blacklist, and whitelist, only one will be effective and the priority is predicate > blacklist > whitelist.

broadcastChannelOption

Redux-state-sync is using BroadcastChannel to comunicate between tabs. broadcastChannelOption is the option passed to broadcastChannel when we creating the channel.

type: Object

default: null

1const config = {
2    // Only 'TOGGLE_TODO' will be triggered in other tabs
3    whitelist: ['TOGGLE_TODO'],
4    // enforce a type, oneOf['native', 'idb', 'localstorage', 'node']
5    broadcastChannelOption: { type: 'localstorage' },
6};
7const middlewares = [createStateSyncMiddleware(config)];

Working with immutable.js

Please check the example_immutable folder.

prepareState

Prepare the initial state for sending to other tabs.

type: Function

default: state => state

1const config = {
2    // Map immutable object to js
3    prepareState: state => state.toJS(),
4};
5const middlewares = [createStateSyncMiddleware(config)];

1import { combineReducers } from 'redux-immutable';
2import { withReduxStateSync } from 'redux-state-sync';
3const rootReducer = combineReducers({
4    todos,
5    visibilityFilter,
6});
7
8export default withReduxStateSync(appReducer, state => Immutable.fromJS(state));

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

127 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-3wcq-x3mq-6r9p
Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2
Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-6x33-pw7p-hmpq
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-7r28-3m3f-r2pr
Warn: Project is vulnerable to: GHSA-r8j5-h5cx-65gg
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-r6rj-9ch6-g264
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-92xj-mqp7-vmcj
Warn: Project is vulnerable to: GHSA-wxgw-qj99-44c2
Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-cwx2-736x-mf6w
Warn: Project is vulnerable to: GHSA-v39p-96qg-c8rf
Warn: Project is vulnerable to: GHSA-8v63-cqqc-6r2c
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-5q6m-3h65-w53x
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
Warn: Project is vulnerable to: GHSA-c9g6-9335-x697
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-9m6j-fcg5-2442
Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v
Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h
Warn: Project is vulnerable to: GHSA-g78m-2chm-r7qv
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-hj9c-8jmm-8c52
Warn: Project is vulnerable to: GHSA-x2pg-mjhr-2m5x
Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj

Score

2.1

/10

Last Scanned on 2025-06-23

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

redux-state-sync-per-instance

Installations

Developer Guide

No

CommonJS

10.16.3

6.14.2

Score

Pull Requests

43

130

71

16

Issues

21

45

24

Releases

Unable to fetch releases

Languages

Developer

AOHUA

Download Statistics

GitHub Statistics

Bundle Size

16.22 kB

5.18 kB

Maintainers

Package Meta Information

Total Downloads

2,664

Dependencies

Dev Dependencies

Redux-State-Sync 3

Why Redux-State-Sync?

How to install

TypeScript support

Before you use

How to use

initMessageListener is a new function to fix the bug that if the other tab not triggering any action on first load, it cannot receive any messages.

Note: if you are already using initStateWithPrevTab, you don't need to initMessageListener anymore.

Note: ignore this if you are using redux-persist, because you will always inite your app with the state in the storage. However, if you don't want to persist the state in the storage and still want to init new tabs with opening tabs' state, you can follow the example above.

Config

channel

predicate

Note: Since version 3.0 the function receives the action itself and not only the action type.

blacklist

whitelist

Warning: You should only use one of the option to filter your actions. if you have all 3 options predicate, blacklist, and whitelist, only one will be effective and the priority is predicate > blacklist > whitelist.

broadcastChannelOption

Working with immutable.js

prepareState

10

10

3

0

0

0

0

0

0

0

2.1

/10

Weekly Downloads

Monthly Downloads

Yearly Downloads

Note: ignore this if you are using `redux-persist`, because you will always inite your app with the state in the storage. However, if you don't want to persist the state in the storage and still want to init new tabs with opening tabs' state, you can follow the example above.