staterize v0.2.0

staterize

A tiny state machine designed for React.

Install

npm install staterize --save

Usage

Example with React:

const state = {
  count: 0
};

const deriveState = [
  {
    isBinary: st => st.count === 0 || st.count === 1
  }
];

class App extends React.Component<any, any> {

  constructor() {
    // init a store
    this.store = staterize(state, deriveState, st => {
      // callback when store state changes
      this.setState(st);
    });
    this.state = this.store(); // get current state
  }

  incr() {
    // now use store to make state changes
    this.store({
      count: this.state.count + 1
      // no need to update isBinary!
    });
   }
 
  render() {
    const { count, isBinary } = this.state;
    return (
      <div>
        {count}
        isBinary: {isBinary ? 'yes' : 'no'}
        <button onClick={this.incr}>+1</button>
      </div>
    );
  }
  }
}

Stand-alone example:

import staterize from 'staterize';

  // prepare your state and its derivations:
  
  const state = { 
    count: 0 
   };
 
  const deriveState = [
    {
      is10: st => st.count === 10
    }
  ];
 
  // what to do when the state is updated:
  
  const onStateChange = st => {
    console.log(st)
  }
  
 // initilize a store from staterize:
 const store = staterize(state, deriveState, onStateChange);

// calling store with no params returns the current state:
 const state = store();
 // { count: 0, is10: false)
 
 // calling store with some state updates:
 store({ count: 10 })
 // triggers the onStateChange callback with the derived state:
 { count: 10, is10: true)