Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xiscodev/store-and-pubsub
A simple library to manage a Store and subscriptions to store values
https://github.com/xiscodev/store-and-pubsub
browser javascript-library pubsub store
Last synced: about 1 month ago
JSON representation
A simple library to manage a Store and subscriptions to store values
- Host: GitHub
- URL: https://github.com/xiscodev/store-and-pubsub
- Owner: xiscodev
- Created: 2021-05-16T20:03:28.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-05-18T17:07:56.000Z (over 3 years ago)
- Last Synced: 2024-04-14T13:05:30.356Z (9 months ago)
- Topics: browser, javascript-library, pubsub, store
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/store-and-pubsub
- Size: 339 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
Store and PubSub
## What is this?
A simple library to manage a Store and subscriptions to store values.
## How to use it?
First you need to import it in your project
*The require way*
```js
let { pullFrom, pushTo } = require("store-and-pubsub");
```
*The import way*
```js
import { unsetPath } from "store-and-pubsub";
```
Then use it to establish a store with getter and setter for a path, for example currentParam
```js
import { pullFrom, pushTo } from "store-and-pubsub";
const MODULE_STORE_NAME = 'moduleStoreName'
// INITIALIZE AN EMPTY STORE FOR YOUR MODULE
pushTo(MODULE_STORE_NAME, {})
// CREATE A SETTER FOR SOME PATH TO STORE
pushTo(`${MODULE_STORE_NAME}.currentParam`, state)
// CREATE A GETTER FOR SOME PATH TO RETRIEVE
pullFrom(`${MODULE_STORE_NAME}.currentParam`)
```
To unset or push multiple values to store
```js
import { unsetPath, pushValuesTo } from "store-and-pubsub";
const MODULE_STORE_NAME = 'moduleStoreName'
// REMOVES THE PROPERTY AT PATH OF STORE
unsetPath(`${MODULE_STORE_NAME}.currentParam`)
// PUSHES MULTIPLE PROPERTIES AND VALUES AT PATH OF STORE
const values = {
prop1: "value1",
prop2: "value2",
}
pushValuesTo(`${MODULE_STORE_NAME}`, values)
```
Paths from store can be subscribed for changes
```js
import { subscribeToPath, unsubscribeFromPath, removeSubscription } from "store-and-pubsub";
const MODULE_STORE_NAME = 'moduleStoreName'
const path = `${MODULE_STORE_NAME}.currentParam`
const myCallback = () => {
// YOUR OWN CODE AND STUFF
}
// SUBSCRIBES TO moduleStoreName.currentParam CHANGES EXECUTING myCallback
const subscriber = subscribeToPath(path, myCallback)
// REMOVES SUBSCRIPTION FRM GIVEN PATH
unsubscribeFromPath(path)
// GIVEN subscriber REMOVES IT FROM PATH SUBSCRIPTION
removeSubscription(subscription)
// GIVEN myCallback REMOVES IT FROM ALL PATHS SUBSCRIBED
removeSubscription(myCallback)
```
Powered by [xiscodev](https://xisco.dev)
Additional JSDOC info
### JSDOC
##### Table of Contents
* [pullFrom](#pullfrom)
* [Parameters](#parameters)
* [pushTo](#pushto)
* [Parameters](#parameters-1)
* [pushValuesTo](#pushvaluesto)
* [Parameters](#parameters-2)
* [unsetPath](#unsetpath)
* [Parameters](#parameters-3)
* [subscribeToPath](#subscribetopath)
* [Parameters](#parameters-4)
* [unsubscribeFromPath](#unsubscribefrompath)
* [Parameters](#parameters-5)
* [removeSubscription](#removesubscription)
* [Parameters](#parameters-6)
#### pullFrom
Retrieves value from stored path.
Type: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)
##### Parameters
* `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** locator string path to store
Returns **any** can be anything stored at given path, anythng stored returns undefined
#### pushTo
Push value to path and notify if could publish.
Type: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)
##### Parameters
* `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** locator string path to store
* `newValue` **any** the value to push
* `forceUpdate` (optional, default `false`)
#### pushValuesTo
Push value to path.
Type: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)
##### Parameters
* `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** locator string path to store
* `values` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** contains multiple keys and values to be pushed to store
#### unsetPath
Removes path stored.
Type: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)
##### Parameters
* `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** locator string path to store
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if unset has been effective, otherwise returns false
#### subscribeToPath
Subscribes to stored path changes with given callback.
Type: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)
##### Parameters
* `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** locator string path to store
* `callback`
Returns **any** reference to be used to single unsubscribe
#### unsubscribeFromPath
Unsubscribe from given paths were has subscribed.
Type: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)
##### Parameters
* `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** locator string path to store
#### removeSubscription
Unsubscribe from all paths were callback or subscriber has subscribed.
Type: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)
##### Parameters
* `callbackOrSubscriber` **([Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function) | [object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object))** to unsubscribe