Giter Club home page Giter Club logo

sust's Introduction

sust

Simple Universal Storage Thingy

Install

npm i sust

Usage

Importing the module

// ES6
import Store from "sust";
// Common.js
const Store = require("sust");

Basic key-value functionality

// Setting and getting values
Store.set("isAwesome", true);
Store.get("isAwesome"); // -> True

// Subscribing to value changes
Store.sub("isAwesome", newValue => console.log(newValue));

// Trigger changes with .pub() or .set()
Store.pub("isAwesome");
Store.set("isAwesome", false); // That's a lie though

// There are some utility functions for value manipulation
// They all trigger .sub() events
Store.set("score", 0);
Store.increment("score", 5);

Store.set("names", ["John", "James"]);
Store.push("names", "Robert"); // -> ['John', 'James', 'Robert']
// to push multiple values use ES6 destructuring
const moreNames = ["Michael", "William"];
Store.push("names", ...moreNames);

Using Actions

Store.addAction("randomNumber", maxValue =>
  Math.round(Math.random() * maxValue)
);
Store.invoke("randomNumber")(42);

Note: Actions are not saved in localStorage

sust's People

Contributors

keeky avatar

Stargazers

 avatar Peter Jeschke avatar

Watchers

James Cloos avatar Davide Becker avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.