Simple State Management Utilities for Angular Apps
- Demo - Coming Soon!
- Setup
- Usage
- schematics
- inspiration
- License
@devlime/ngx-state was created to simplify state management in Angular applications. We do not consider it a "framework" but rather a bag of utilities to help make the world a better place by making performant state management EASY in Angular without the need to learn YET ANOTHER FRAMEWORK or REDUX! @devlime/ngx-state provides a VERY SIMPLE type-safe state class to extend from, a handful of decorators to help make your life more enjoyable while keeping state CLEAN & READABLE, and a *subscribe directive so you aren't *ngIfing your life away
yarn add @devlime/ngx-state if you wanna be hip
or
npm install @devlime/ngx-state --save if your neck has a beard
Bear with us... We promise next time you check this it will be filled in
The State "service" class is a base class to extend your state(s) from. It takes in an interface and provides a type-safe set function. It is recommended that your States be used only to store your state data and that's it.
The decorators in @devlime/ngx-state were created to make your life easy by keeping states clean and readable. Behind the scenes the property decorators leverage Object.defineProperty to create both hidden private, and public properties with setters and getters that provide immutability and indirect access to your state data.
T: extends State, P: value type
defaultValue: P = null
The @StateProp decorator is used to store a plain (non-observable) value that doesn't need to be subscribed to.
T: extends State, P: BehaviorSubject value type
defaultValue: P = null
The @StateBehavior decorator is used to store a value as an RxJS BehaviorSubject. When creating a @StateBehavior the decorator will automagically create a second property of the same name but with a $ suffix. The property will be used to access the BehvaiorSubject via the asObservable method. You should also manually add this second property to the state to maintain proper typings.
T: extends State, P: ReplaySubject value type
replaylength: number = 1
T: extends State, P: value type
N/A
Angular schematics for @devlime/ngx-state are already underway! Update coming soon!
Project inspired by Angular and how awesome it is when used properly (with great power comes great responsibility).
Created by John Pribesh for Devlime Labs
@devlime/ngx-state is released under the MIT license for you to enjoy, abuse, or fall in love and have 3 kids with. This is our gift to you and what you do with it is your call!