npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

storux

v0.11.4

Published

Easy and powerful state store (Flux implementation) using actions, listeners and reducers (optional).

Downloads

87

Readme

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 Tallefourtane - Nicolab.net | |---| | Nicolas Talle | | Make a donation via Paypal |

Contributors

Thanks to Irwin lourtet for the feedback.