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

immux

v0.1.3

Published

Immutable state container for JavaScript

Downloads

7

Readme

Immux

JavaScript state container


npm install --save immux

This project is in development, and may contain some bugs. It doesn't have any tests yet.

Immux is a JavaScript state container, similar to Redux, but with some differences:

  • Actions are functions, not cases in a switch statement
  • There are no action creators (they're sort of the same as the reducer)
  • You bind your entire reducer hierarchy once, not in each component

Rather than trying to explain, lets first see the mandatory counter app example code:

Code sample

import { createStore, Adapters } from "immux";

// we use kjappas to define view templaes
import { createRefresh, infest } from "kjappas";

// we use SimpleImmutable as our data format
import SimpleImmutable from "simple-immutable";

// define the kjappas HTML tag helpers globally
infest(window);

// The reducer definition tree that we will bind to our immux store.
// The nesting structure accomplishes the same as combineReducers in Redux.
const reducers = {
  counter: {
    // initial counter state
    initial: {value: 0},

    increment: (state, addend) =>
      state.set("value", state.get("value") + addend || 1)
  }
};

// Our root view template; a pure function from root state and dispatchable
// actions, to virtual dom view.
// $ is a bound version of the reducer tree which can be used to dispatch
//   state changes.
// _ is the root state (as plain JavaScript, because this is the default
//   for the SimpleImmutable adapter that we use here).
function CounterView($, _) {
  return div(".hello",
    h1("Mandatory counter app"),
    button(
      {
        // Dispatch counter increment action on click
        $click: () => $.counter.increment(1)
      },
      // Show the current value of the counter
      "Value: " + _.counter.value)
  );
}

// Create an adapter for our data format (SimpleImmutable),
// and a store, which binds the reducer definition tree.
const
    adapter = Adapters.SimpleImmutable(SimpleImmutable),
    store   = createStore(reducers, adapter);

document.addEventListener("DOMContentLoaded", function() {

  // Create the refresh function, which can be used to draw the template
  // to the dom.
  const refresh = createRefresh(
    CounterView,
    document.getElementById("app-placeholder"));

  // Subscribe the refresh function to state changes
  store.subscribe(refresh);
  // Do the initial refresh, passing the bound reducer tree and the
  // initial state from the store.
  refresh(store.$, store._);
});

Relatives: globus | SimpleImmutable | kjappas

API reference

TODO: gentler introduction

createStore(reducerTree, adapter)

Given a tree of reducer definitions, and the data type adapter for the data type used by the reducers and initial values of the tree, return an immux store object with the fields {$, _, subscribe}.

The returned field $ is a tree of bound reducer functions that can be called to cause state changes. This is the immux equivalent to store.dispatch in Redux. The tree of bound reducers is a one-to-one mapping of the tree of reducer function definitions, however, the bound reducer functions no longer take a first state parameter, and no longer return state. Instead, they cause those state changes to the store.

The returned field _ is the inital state that was extracted from the tree of reducer definitions. This can be used however you like, but most typically for the initial draw call, before state changes have had the chance to trigger a subscribed refresh.

The returned field subscribe is a function taking any number of arguments, each one being a listener function of four parameters, such as listener($, _, func, params).

  • $ is the same object as the $ described earlier.
  • _ is the current state, which may change between invocations; unlike $.
  • func is the reducer function that caused the state change that triggered the listener function.
  • params are the parameters to the call to that function.

Reducer defintion functions always take state as their first parameter, and must return the state they wish to cause.

Bound reducer functions no longer take the state as their first parameter, and no longer return the updated state. However, when they are called, they will inflict this state change on the store that they are bound to.

Reducer state is local by default. A reducer residing at root.users.add, may only access state and cause changes under the users path (unless it is marked as global, see further down).

TODO: examples

consoleLogger(tree, state, func, args)

A simple console logger that can be subscribed on a store to print all dispatched state changes.

TODO: example

global(reducerFunc)

Marks a reducer function definition as global. Global reducers work on the root state rather than the local state, even if they are nested at a deeper level.

TODO: example

produce(value)

Used to define reducers that return values. Reducers cause state changes by returning the updated state. However, some times, you might want to be able to return some other value from the reducer, which will be of use at the call site of the bound reducer function. Since the return value is already being used to magically update state, we have to use another mechanism. Calling produce(value) inside a reducer function definition will cause the bund reducer to return that value when called.

TODO: example

Adapters

Adapters.SimpleImmutable(SimpleImmutable)

SimpleImmutable is an immutable data type that was designed specifically for immux. It lets us to pass the state to the view as plain js without any performance penalty. For a usage example, just se the example code near the top of this README.