|
| 1 | +# angular-redux2/sync |
| 2 | +Angular-redux2-sync is a lightweight middleware for synchronizing the Redux state between different tabs/windows in the same browser. |
| 3 | +It uses the Broadcast Channel API to communicate with other tabs and dispatches the same actions that were dispatched in other tabs to keep the state in sync. |
| 4 | + |
| 5 | +[](https://discord.com/invite/7BnsAqst6W) |
| 6 | +[](https://www.npmjs.com/package/@angular-redux2/sync) |
| 7 | +[](https://www.npmjs.com/package/@angular-redux2/store) |
| 8 | + |
| 9 | +## Installation |
| 10 | +You can install angular-redux2/sync using npm: |
| 11 | +```bash |
| 12 | +npm install @angular-redux2/sync |
| 13 | +``` |
| 14 | + |
| 15 | +## Usage |
| 16 | +To use angular-redux2/sync, you need to create an instance of the SyncService class and add it to your Reducer middleware chain. |
| 17 | +```typescript |
| 18 | +ngRedux.configureStore(<any>rootReducer, INITIAL_STATE, [ |
| 19 | + reduxSyncMiddleware({ initState: true }) |
| 20 | +], enhancer); |
| 21 | +``` |
| 22 | + |
| 23 | +The `SyncService` constructor takes an optional `ConfigSyncInterface` object that can be used to customize the behavior of the `synchronization`. |
| 24 | +Here are the available options: |
| 25 | + |
| 26 | +* `channelName` (optional): The name of the communication channel to use for action synchronization. If not specified, a default value of "redux-sync" will be used. |
| 27 | +* `initState` (optional): A boolean flag indicating whether to copy the initial state from another tab (if available). If set to true, an initial state request will be sent to other tabs through the communication channel. |
| 28 | +* `blacklist` (optional): An array of actions that will not be triggered in other tabs. If an action matches any of the types in this array, it will not be synchronized with other tabs. |
| 29 | +* `whitelist` (optional): An array of actions that will be triggered in other tabs. If this array is specified, only actions that match the types in this array will be synchronized with other tabs. |
| 30 | +* `predicate` (optional): A function that can be used to filter the actions to be synchronized based on custom criteria. This function takes an action object as its parameter and should return a boolean value indicating whether the action should be synchronized. |
| 31 | +* `prepareState` (optional): A function that can be used to prepare the initial state for synchronization with other tabs. This function takes an action object as its parameter and should return the modified initial state object. |
| 32 | + |
| 33 | +> Note that when using multiple options (`predicate`, `blacklist`, and `whitelist`), only one of them will be effective. |
| 34 | +> The priority is `predicate` > `blacklist` > `whitelist`. |
0 commit comments