Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/n0th1ng-else/minimal-store
Minimalistic implementation of the reactive store pattern
https://github.com/n0th1ng-else/minimal-store
minimalistic no-dependencies reactive-programming store
Last synced: about 1 month ago
JSON representation
Minimalistic implementation of the reactive store pattern
- Host: GitHub
- URL: https://github.com/n0th1ng-else/minimal-store
- Owner: n0th1ng-else
- License: mit
- Created: 2019-08-08T17:40:28.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-02-06T15:53:08.000Z (almost 4 years ago)
- Last Synced: 2024-12-12T23:13:43.775Z (about 2 months ago)
- Topics: minimalistic, no-dependencies, reactive-programming, store
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/minimal-store
- Size: 403 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# minimal-store
Minimalistic implementation of the **reactive store** pattern
- **322 Bytes**, according to [size-limit](https://github.com/ai/size-limit/)
- **No** dependencies
- **100% test** coverage
- ES Module
# Badges
[](https://circleci.com/gh/n0th1ng-else/minimal-store/tree/master)
[](https://github.com/semantic-release/semantic-release)
[](https://www.npmjs.com/package/minimal-store)
[](https://jestjs.io)
[](https://codecov.io/gh/n0th1ng-else/minimal-store)
## Usage
There are differend kinds of store you can use:
- writableStore
- freezableStore
- readableStore
All stores apply weak data i.e. you can use `null` (update with no value) to clear store value.
### writableStore
`writableStore` as called - can be updated without any limit. You can update data all the time as you want to.
### freezableStore
`freezableStore` reflects the second parameter while being initialized - it defines how many time you can update store. The default is **once** (`=== 1`).
### readableStore
`readableStore` stores the initial value and never being updated.
All subscribers will be executed once with the value store contains.
## Examples
- Simple example:
```js
import { writableStore } from 'minimal-store';
const pageSize = writableStore(20);
pageSize.subscribe(size => {
// do something with _size_
// subscription will be called with `size === 20`
// then with `size === 21`
});
pageSize.update(oldValue => oldValue + 1);
```
- readable store
```js
import { readableStore } from 'minimal-store';
const pageSize = readableStore(20);
pageSize.subscribe(size => {
// do something with _size_
});
pageSize.update(oldValue => {
// pageSize will never be update as it is a readableStore
// return value does not make any sense in this case
});
```
- freezable store:
```js
import { freezableStore } from 'minimal-store';
const freezeCount = 3;
const pageSize = freezableStore(20, freezeCount);
pageSize.subscribe(size => {
// do something with _size_
});
pageSize.update(oldValue => {
// pageSize will be updated first 3 times and then will be freezed
const newValue = 21; // any value you want to return
return newValue;
});
```
- Promise-like update:
```js
import { writableStore } from 'minimal-store';
const pageSize = writableStore(20);
pageSize.subscribe(size => {
// do something with _size_
// first time it receives `size === 20`
// then `size === 100`
});
pageSize.update(oldValue => {
// update function can be async!
return Promise.resolve(100);
});
```
- Handling update errors:
```js
import { writableStore } from 'minimal-store';
const pageSize = writableStore(20);
pageSize.subscribe(size => {
// do something with _size_
});
pageSize
.update(oldValue => {
// update function can be async!
return Promise.reject(new Error('Something went wrong...'));
})
.catch(err => {
// err.message === 'Something went wrong...'
});
```
- Use current value to update store:
```js
import { writableStore } from 'minimal-store';
const pageSize = writableStore(20);
pageSize.subscribe(size => {
// do something with _size_
});
pageSize.update(oldValue => {
return oldValue + 10;
});
```
- Store rely on weak data i.e. you always can pass **null** as a new value:
```js
import { writableStore } from 'minimal-store';
const pageSize = writableStore(20);
pageSize.subscribe(size => {
// do something with _size_
// first time `size === 20`
// next `size === null`
});
pageSize.update(oldValue => null);
```