You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Simple opinionated state management library based on RxJS
Installation
npm install --save rxstate rxjs
Quick start
Example code for creating a store with status and typeahead fetching action is shown below:
importfetchivalfrom'fetchival';import{from}from'rxjs';import{map,filter,debounceTime,distinctUntilChanged,tap,flatMap}from'rxjs/operators';import{createStore,createAction,createStatus}from'rxstate';// create status actionconststatus=createStatus();// create action that fetches typeahead suggestions from serverconstgetTypeahead=createAction();consttypeahead$=getTypeahead.$.pipe(map(e=>e.target.value),filter(q=>q.length>3),debounceTime(300),distinctUntilChanged(),tap(()=>status('loading')),flatMap(q=>from(fetchival(typeaheadAPI).post({q}))),tap(()=>status('done')));// create an array of action streams for storeconststreams=[status.$,typeahead$];// create storeconststore=createStore({streams,defaultState: {init: true}});// other place in code:// subscribe for state updatesstore.subscribe(state=>{console.log(state);// ... handle your state here});// other place in code:// trigger actiongetTypeahead('keyword');
Things to keep in mind
Rxstate has RxJS as peer dependency - don't forget to install it as well!
Store will always return last value to new subscribers.
By default, the state is updated using spread operator on new and old state (e.g. {...oldState, ...newState}). You can change that by passing combinator parameter during store creation, e.g.:
// create combinator that always returns new stateconstcombinator=(_,data)=>data;// create storeconststore=createStore({streams, defaultState, combinator});
Status action and stream can be created using createStatus function. By default it'll write status as {status: 'statusText'}. Key can be changed by passing the string parameter to the function, e.g.:
// create status with custom keyconststatus=createStatus('customStatus');// state will be updated with {customStatus: 'statusText'}
Stores have .clear() method that accepts new initial state as an optional argument and dispatches new action with either provided or default state as value. If you use default combinator logic - this will reset your state to initial one.