store3 v1.2.0

Store3

Simple, light-weight store

A library written 80% using Github copilot

Installation

Install Store3 with npm

  npm install store3

Running Tests

To run tests, run the following command

  npm run test

Usage

import Store3 from 'store3';

const store = new Store3();

// using default key:values
const store = new Store3({
    a: "Some value",
    b: 128 * 14
});

// insert additional value
store.set('new_key', { other: 'value' });

store.get('a'); // "Some value"
store.get('b'); // 1792
store.get('new_key'); // { other: "value" }

Using getters > store.$

import Store3 from 'store3';

const store = new Store3();

store.set('some_key', 'some value');

store.$.some_key; // "some value"

Using change subscription

import Store3 from 'store3';

const store = new Store3();

store.set('a', 'value');
store.subscribe('a', (value, prevValue, $) => {
    console.log(value, prevValue, {...a});
});
store.set('a', 'newVal');
// will log:
// newVal value {a: "newVal"}

import Store3 from 'store3';

const store = new Store3();

// Also able to subscribe before define
store.subscribe('a', (value, prevValue, $) => {
    console.log(value, prevValue, {...a});
});
store.set('a', 'newVal');
// will log:
// newVal undefined {a: "newVal"}

import Store3 from 'store3';

const store = new Store3();

// Also able to subscribe before define
const unsubscribe = store.subscribe('a', (value, prevValue, $) => {
    console.log(value, prevValue, {...a});
});
store.set('a', 'newVal');
// will log:
// newVal undefined {a: "newVal"}

unsubscribe();
store.set('a', 'Something'); // no log