https://github.com/turtleflyer/use-interstate
Simple and powerful state management solution for React
https://github.com/turtleflyer/use-interstate
Last synced: 4 months ago
JSON representation
Simple and powerful state management solution for React
- Host: GitHub
- URL: https://github.com/turtleflyer/use-interstate
- Owner: turtleflyer
- License: unlicense
- Created: 2021-03-30T08:00:12.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-11-18T09:45:35.000Z (over 4 years ago)
- Last Synced: 2025-10-11T14:13:19.104Z (8 months ago)
- Language: TypeScript
- Homepage:
- Size: 4.91 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: docs/SecurityNotes.md
Awesome Lists containing this project
README
# use-interstate
*use-interstate* is a state management library for *React*.
> *:warning: The library is now at the beta stage. Any implementations in projects are welcome.
> Please feel free to share your experience with us
> ([turtlefly@gmail.com](mailto:turtlefly@gmail.com)).*
## Highlights
* The library does not have dependencies (polyfilled code depends on *@babel/runtime* to avoid
duplications).
* It [ensures the
performance](https://github.com/turtleflyer/compare-react-state-management-solutions) to be at
least on the same level as the popular state management libraries for *React*, e. g. *Redux*,
*Recoil*.
* It has a small size.
* It is heavily tested (more than 40 tests performed on the source code as well as on bundled code).
* It is written with the use of the standard React hooks only, thus ensuring better compatibility.
* It is written in *TypeScript* and typed the way the error messages are [speaking the human
language](docs/UseWithTypeScript.md#error-messages) (💣💥🙈 *You will love it!*).
* The logic of the *use-interstate* library is aligned and synchronized with the natural life cycles
of *React* components which make the use and feel similar to the standard *React* hook `useState`
.
* It does not require having a *Context Provider* at the root of the component tree of an
application, thus ensuring [better security for
applications](docs/SecurityNotes.md#why-not-context-provider).
* It is unopinionated and agnostic to application architecture, so one can use the library adopting
either redux-like paradigm with actions, reducers, and selectors, state machine, or use it simply
as an "interstate" variant of the standard `useState` hook which is great for prototyping and
creating proofs of concepts.
* It is compatible with *Concurrent mode* of *React*.
## Install
```bash
npm i use-interstate
```
* [Use](docs/Use.md)
+ [`initInterstate`](docs/Use.md#initinterstate)
+ [`useInterstate`](docs/Use.md#useinterstate)
+ [`readInterstate`](docs/Use.md#readinterstate)
+ [`acceptSelector` method](docs/Use.md#acceptselector-method)
+ [`setInterstate`](docs/Use.md#setinterstate)
+ [`resetInterstate`](docs/Use.md#resetinterstate)
+ [deps](docs/Use.md#deps)
* [*use-interstate* and *TypeScript*](docs/UseWithTypeScript.md#use-interstate-and-typescript)
+ [Error messages](docs/UseWithTypeScript.md#error-messages)
+ [Dev types](docs/UseWithTypeScript.md#dev-types)
* [Why not *Context Provider*](docs/SecurityNotes.md#why-not-context-provider)