Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/regou/justore
Just Flux Store, noting else
https://github.com/regou/justore
flux immer immutablejs pubsub rxjs state-management
Last synced: about 1 month ago
JSON representation
Just Flux Store, noting else
- Host: GitHub
- URL: https://github.com/regou/justore
- Owner: regou
- License: mit
- Created: 2015-09-01T13:56:28.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-06-24T06:12:55.000Z (over 5 years ago)
- Last Synced: 2024-10-11T14:08:33.064Z (3 months ago)
- Topics: flux, immer, immutablejs, pubsub, rxjs, state-management
- Language: JavaScript
- Homepage:
- Size: 119 KB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Justore
[](https://travis-ci.org/regou/justore)
[](https://www.npmjs.com/package/justore)
[](http://standardjs.com)
We don't need flux , just the store!
### Installation
```sh
npm install justore --save
```
### Basic Usage
```js
var justore = require("justore");
var initData = {};
var store = new justore(initData,'Store Name');
//Write or change data to store, return a Promise
store.write('todos',['drink','cook']);
//Subscribe to change
let subscription = store.sub('todos.0',function(newVal,prevVal){
store.read('todos') === newVal //true, 'drink'
});
//Remember to clean up
subscription.unsubscribe();
```
### Advanced usage
- `store.batchWrite([keyPaths], manipulateFunction);`
Batch write multiple data to the store, only emit if it's listed on the keyPaths
```js
store.batchWrite(['vtext', 'enable'], draft => {
draft.vtext.i = 10
draft.enable = true
draft.pos = 12 // works, but no event emit
});
```
- `store.write(keyPath, data [,options])`
Write data to the store, return store
```js
store.write('todos',['drink','cook'],{
//Boolean. If true, change the store without trigger any events
mute:false
});
```
- `store.sub(keyPath[,onNext][,immediate])`
Subscribe to the store, if onNext is defined, return an Rx Subscription, else return an Rx stream
```js
store.sub('todos.1',function (newVal, oldVal) {
//do tings
});
```
- `store.read(keyPath)`
Get value for attribute by passing the key.
```js
store.read("todos.0") //--> 'drink'
```
- `store.delete(keyPath)`
Useful when you want to delete a root key and it's data
```js
store.delete("todos")
store.report() //--> {}
```
- `store.report()`
return the full store data. You cannot manipulate it
- `store.debugOn`
if a key in this array, will toggle JS breakpoints when writing that key
### React Mixin helper
- `store.createReactMixin(key)`
Return a mixin. Will call `onStoreChange` method on a React component when store change.
### Auto unsubscibe
If the subscribed data has been deleted (not set to undefined), the subscription will unsubscribe automatically
### Browser support
IE11 or higher