pub-sub-store is a small state manager store that can be used to manage application state providing reactivity through subscription method.
Use the package manager npm to install pub-sub-store
npm install @n0n3br/pub-sub-store
- Centralized state management
- Protected state (can't be mutated directly)
- setState method to mutate state and trigger subscribers callbacks
- subscribe method to watch and react to desired state changes
You need just three steps to start using pub-sub-store
- Create the Store
const store = new Store(); // empty state or
const otherStore = new Store({ name: 'Rogerio' }); // optional initial state
- Subscribe to store changes
// the subscribe method requires two parameters:
// 1. a callback function that will be called when the state changes
// 2. a configuration function that describes wich state mutations should be watched
// and returned to the callback function
// both parameters are functions that receive the state
const callbackFunction = state => console.log(`Received state : ${JSON.stringify(state)}`);
// only changes to the state.name attribute will be watched
const configurationFunction = state => {
return {
name: state.name,
};
};
store.subscribe(callbackFunction, configurationFunction);
- Mutate the state
store.setState({ name: 'Rogerio', age: 44 });
import Store from '@n0n3br/pub-sub-store';
const store = new Store({ a: 1, b: 3 });
console.log(store.state);
const callback = state => console.log(`a value changed to ${state.a}`);
const config = state => {
return { a: state.a };
};
subscribe(fn, config);
store.setState({ a: 2 });
var Store = require('@n0n3br/pub-sub-store').default;
var store = new Store();
var callback = function(state) {
console.log(`received state : ${JSON.stringify(state)}`);
};
var config = function(state) {
return { a: state.a };
};
store.subscribe(callback, config);
store.setState({ a: 2 });
<!-- to import non-minified version -->
<script src="pub-sub-store.umd.js"></script>
<!-- to import minified version -->
<script src="pub-sub-store.umd.min.js"></script>
After this the library will be available to the Global as pubSubStore:
const store = new pubSubStore({ a: 1, b: 3 });
console.log(store.state);
const callback = state => console.log(`a value changed to ${state.a}`);
const config = state => {
return { a: state.a };
};
store.subscribe(fn, config);
store.setState({ a: 2 });
There are two other examples in the repository. One of them is for NodeJS and the other is a browser todo app that adds, remove and marks/unmarks tasks as done.
This library contains all tests in the tests folder.
The tests are writen using mocha, chai, sinon and sinon-chai.
To run the tests just use nodejs test script:
npm run test
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
We use SemVer for versioning. For the versions available, see the tags on this repository.
Rogério Amorim |
See also the list of contributors who participated in this project.