https://github.com/dashersw/regie
An observable state management tool for vanilla JS applications based on Proxies
https://github.com/dashersw/regie
es6-proxies state-management state-manager vanilla-js
Last synced: 11 months ago
JSON representation
An observable state management tool for vanilla JS applications based on Proxies
- Host: GitHub
- URL: https://github.com/dashersw/regie
- Owner: dashersw
- License: mit
- Created: 2019-01-19T19:32:37.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-01T12:38:59.000Z (about 2 years ago)
- Last Synced: 2025-04-05T16:22:58.507Z (about 1 year ago)
- Topics: es6-proxies, state-management, state-manager, vanilla-js
- Language: TypeScript
- Homepage:
- Size: 268 KB
- Stars: 79
- Watchers: 6
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# regie
[](https://badge.fury.io/js/regie)
[](https://travis-ci.org/dashersw/regie)
[](https://coveralls.io/github/dashersw/regie)
[](https://david-dm.org/dashersw/regie)
[](https://raw.githubusercontent.com/dashersw/regie/master/LICENSE)
**An observable state management tool for vanilla JS applications based on Proxies**
## Example
```js
const regie = require('regie')
const initialState = {
items: []
}
const { state, observe } = regie({ initialState })
observe(state.items, (newValue, change) => {
console.log(`new value is ${newValue} with change:`, change)
})
state.items.push('first!')
```
## Installation
```bash
npm i regie
```
## Usage
`observe` function accepts many forms, including a string path and a predicate. All of the following are the same:
```js
const regie = require('regie')
const initialState = {
items: []
}
const { state, observe } = regie({ initialState })
observe(state.items, handler)
observe(state => state.items, handler)
observe(() => state.items, handler)
observe('items', handler)
const items = state.items
observe(items, handler)
observe(() => items, handler)
```
regie also allows you to watch primitive values in a certain form. The following examples observe the _future_ first element of the array:
```js
observe(() => state.items[0], handler)
observe('items.0', handler)
```
and the following examples observe _even farther into the future_ details of the first element of the array:
```js
observe(() => state.items[0].name, handler)
observe('items.0.name', handler)
```
## License
MIT License
Copyright (c) 2019 Armagan Amcalar
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.