README.md

Storux

Easy and powerful state store (Flux implementation) using actions, listeners and reducers (optional). Storux is a state store manager, to manage the state of an application (Website, App mobile, Web App, Node API, ...).

You can manage the entire state of your project with a single store or separate the state into many specific stores (authStore, articleStore, commentStore, appStore, ...).

Storux's philosophy is to be easy to use and productive. Powerful and makes life easier for the front developer.

Browser and server, both are supported (great for SSR).

Take advantage of the possibilities and Enjoy!

Install

With NPM:

npm install storux --save

or with Yarn:

yarn add storux

Usage

💡 Recommended Take a quick tour in the doc: Learn Storux.

Storux supports ESM (ES Module / import), CJS (CommonJS / require) and UMD (Universal Module Definition). So Storux can be imported from ESM and CJS, ...

Quick example:

// myStore.js

import {Storux, action, hook} from 'storux';
const storux = new Storux();

class MyStore extends storux.Store {
  constructor(opt) {
    super(opt);

    this
      .scope
      // helpers that generate some actions
      .ensureActions(
        'fetchDone',
        'fetchFail'
      )
    ;

    this.scope.initialState = {
      count: 0,
      data: null,
      err: null,
    };
  }

  /**
   * Add a number to the counter.
   *
   * @param {number} num
   * @return {Promise} Promise that resolve the new counter value.
   */
  @action('add')
  add(num) {
    let state = this.getState();
    let count = state.count + num;

    this._save({count});

    return count;
  }

  /**
   * Fetch a resource.
   *
   * @param {string} id Resource ID.
   * @return {Promise} Resolve the resource data.
   */
  @action('fetch')
  fetch(id) {
    this._dispatch(id);

    // like axios and other HTTP lib
    return http
      .get('/some-resource/' + id)
      .then((res) => this.fetchDone(res.data))
      .catch(this.fetchFail)
    ;
  }

  /**
   * FetchDone() handler.
   *
   * @param {object} ns The next state.
   * @param {object} data Some data.
   * @return {object} Returns the next state.
   */
  @hook('fetchDone')
  onFetchDone(ns, data) {
    ns.data = data;

    return ns;
  }

  /**
   * FetchFail() handler.
   *
   * @param {object} ns The next state.
   * @param {Error} err Error instance.
   * @return {object} Returns the next state.
   */
  @hook('fetchFail')
  onFetchFail(ns, err) {
    ns.data = null;
    ns.error = err;

    return ns;
  }
}

export default storux.create(MyStore);

And use this store:

// app.js

import myStore from './stores/myStore';

myStore.fetch('db-id-xyz').then((data) => {
  console.log('data: ', data);
});

myStore.add(42).then((count) => {
  console.log('count: ', count);
});

// Get the current state
console.log(myStore.getState());

// It's more relevant to use the lifecycle, like "listen()" and "unlisten()".
// Example for render the state in a UI component.

Also, each store is accessible via the Storux instance that was used to create it. Example, the new instance of MyStore is accessible via storux.stores.myStore.

The store name is the class name with the first letter lowercased. You can customize the store name if needed, example:

// WebSocket store
class WSStore extends storux.Store {
  get displayName() {
    return 'wsStore';
  }

  // ...
}

💡 Take a quick tour in the doc: Learn Storux (recommended).

LICENSE

MIT (c) 2016, Nicolas Tallefourtane.

Author

Nicolas Talle

Contributors

Thanks to Irwin lourtet for the feedback.