rioter v1.0.2

Rioter

JavaScript library for handling state management efficiently.

Installation

npm i rioter

Get started

Atom

An Atom is an object that will keep some data.

import { Atom } from "rioter";

class CounterAtom extends Atom {
  constructor(store) {
    super(store);

    this.number = 0;
  }

  increment() {
    this.number++;

    this.update(); // notify the store of an update
  }
}

Store

A Store is formed by a group of Atoms.

import { Store } from "rioter";

import CounterAtom from "./CounterAtom";

const store = new Store({ counter: CounterAtom }); // actual objects will be created internally

const state = store.getState();

// state.counter.number = 0

Every time there's a change in one of the Atoms, Store will emit an update event.

const state = store.getState();

setTimeout(() => {
  state.counter.increment();
}, 5000); // execute after 5 seconds

store.on("update", () => {
  // state.counter.number = 1
});

Persistor

Persistor will add persistence to your Store.

import { Store, Persistor } from "rioter";

import CounterAtom from "./CounterAtom";

const store = new Store({ counter: CounterAtom });

const persistor = new Persistor(store, window.localStorage);

persistor.init().then(() => {
  // persistor has been loaded
});

We can choose which atoms are persisted just by overriding two methods: hydrate and persist.

import { Atom } from "rioter";

class CounterAtom extends Atom {
  constructor(store) {
    super(store);

    this.number = 0;
  }

  // hydrate will be called when we have read the data from Storage
  // so we can update the atom properties accordingly

  hydrate(data) {
    this.number = data;
  }

  // persist will be called every time there's an update in the store,
  // the data this method returns is what will be saved in Storage,
  // if null is returned, this atom will not be persisted,
  // null is returned by default

  persist() {
    return this.number;
  }

  // handlers

  increment() {
    this.number++;

    this.update();
  }
}