Centrally manage state for React applications with CSP
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
test
.gitignore
.npmignore
.travis.yml
LICENSE
README.md
index.d.ts
index.js
package.json

README.md

state trooper

Example Usage

Call StateTrooper.patrolRunLoop in your route handler/main app entry point

const config = {
  // describe the state for the page
  state: {
    serverReport: null,
    bio: null,
    activity: null
  },

  // describe the fetchers and persisters for each piece of state
  // fetchers and persisters are functions that should return channels
  dataStore: {
    'serverReport': { fetcher: serverReportFetcher },
    'bio': { fetcher: bioFetcher, persister: bioPersister },
    'activity': { fetcher: activityFetcher }
  }
};
const cursor = StateTrooper.patrolRunLoop(config, (cursor) => {
  // Re-render the component when state changes generate new cursors
  React.render(<Server cursor={cursor}/>, document.querySelector('body'));
});

// Render the component with the initial cursor
React.render(
  <Server cursor={cursor}/>,
  document.querySelector('body')
);

Using cursors inside of the components

const Server = React.createClass({
  render: function () {
    return (
      <div>
        <ServerReport cursor={this.props.cursor.refine('serverReport')}/>
        <Bio cursor={this.props.cursor.refine('bio')}/>
      </div>
    );
  }
});

const Bio = React.createClass({
  render: function () {
    const bio = this.props.cursor.deref();

    if (bio) {
      return (
        <form>
          <label>Name</label>
          <input type='text' value={bio.name} onChange={this.handleChange}/>
          <button onClick={this.handleSaveClick}>Save</button>
        </form>
      );
    }
    else {
      return null;
    }
  },

  handleChange: function (ev) {
    this.props.cursor.set({ name: ev.target.value });
  },

  handleSaveClick: function () {
    this.props.cursor.persist();
  }
});

Fetchers will be called with a cursor and a rootCursor Persisters will be called with a cursor, a change and a rootCursor

To have your fetchers or persisters change the state, simply use one of the mutating functions of a cursor.

How state changes are applied

State change are applied one after each other. Making a change will always produce a new top level cursor with the update state. However there are cases where you can call request several mutate changes via any of the mutative functions on a cursor (set, replace, add, remove) in short succession. In cases like this the state changes might be requested before the first change is propegated. StateTrooper ensures that the changes are applied sequentially regardless of wether or not a new cursor has been added to the cursor chan yet.

Cursor API:

Given this state:

{
  foo: {
    bar: 'baz',
    beep: ['hey', 'yo']
  }
}

cursor#refine

cursor.refine('foo.bar');

Calling cursor#refine with a string path will create a new cursor for that part of the state. This is useful as you go down the component tree and the focus your component and state on a specific domain.

cursor#deref

cursor.refine('foo').deref();
// or
cursor.deref('foo');

Calling cursor#deref returns the value at the refined location. If a path is provided, the path will be used starting at the refined location.

cursor#set

cursor.refine('foo').set({ bar: 'foo' });

Calling cursor#set will merge the changes into the state at the path of the cursor. Similar to reacts setState. In this example the state change will result in:

{
  foo: {
    bar: 'foo',
    beep: ['hey', 'yo']
  }
}

set is only available on Objects/Maps

cursor#replace

cursor.refine('foo').replace('bar');

Calling cursor#replace will replace the entire subtree at the path of the cursor In this example the state change will result in:

{
  foo: 'bar'
}

cursor#remove

cursor.refine('foo.beep.0').remove();

Calling cursor#remove will remove the entire subtree at the path of the cursor. This works on both arrays and objects. In this example the state change will result in:

{
  foo: {
    bar: 'baz',
    beep: ['yo']
  }
}

cursor#add

cursor.refine('foo.beep').add('yo');

Calling cursor#add will push a new value on the end of the array held by the cursor. In this example the state change will result in:

{
  foo: {
    bar: 'baz',
    beep: ['hey', 'yo', 'yo']
  }
}

add is only available on Array values.

cursor#equals

this.state.cursor.equals(newState.cursor);

This method compares the state encapsulated by two cursors. If the cursors hold equivalent values, based on the result of an equals() method, comparison by Object.prototype.valueOf(), or comparison of key/value pairs on the object. If you are a React user, this method can be useful for implementing shouldComponentUpdate.

Monitoring Changes

StateTrooper also provides a mechanism for monitoring a piece of state and being notified when it changes. These are called "stakeouts". These are useful when an application needs to respond to a change in one piece of state, such as changing a user preference, and make further state changes.

StateTrooper.stakeout

StateTrooper.stakeout('activityReport', (update, cursor) => {
  // The `update` holds the new value and the action that caused the update
  // The `cursor` is the root cursor.
  if (update.value.somethingExcitingChanged) {
    fetch(myExcitingService)
      .then(response => response.json())
      .then(json => cursor.replace('myExcitingState', json));
  }
});

StateTrooper.patrol

  function handleActivityReportChange(update, cursor) {
    console.log('handleActivityReportChange', update);
  }

  const cursorChan = StateTrooper.patrol({
    // describe the state for the page
    state: {
      activity: null,
      activityReport: null
    },
    stakeout: {
      'activityReport': [handleActivityReportChange]
    }
  });

API Changes

A major change in the 2.x release of state-trooper is the removal of immutable-js as the internal data structure for storing state.

The following APIs changed in v2.x:

  • cursor#deref(): Values returned are not immutable-js Maps or Lists.

  • cursor#derefJS(): REMOVED

  • cursor#hasSameValue(): Renamed to cursor#equals.

  • cursor#map(): REMOVED

  • StateTrooper#stakeout(): ADDED

  • StateTrooper#patrol(): The "config" object supports a stakeout property.