antiflux

Antiflux

A lightweight, zero-dependency, observable state manager, exclusively for Node.js, for when reactive stage managers and their attendant boilerplate are extreme overkill.

Installation

npm install antiflux || yarn add antiflux

Usage

import { Antiflux } from 'antiflux'

const store = new Antiflux([initialState], [options], [getters])

Set key

Add or update a key.

store.set('myKey', 'myValue')

Has key

Check if a key exists. Responds with a boolean.

store.has('myKey')

Get key

Responds with the key value.

const myValue = store.get('myKey')

Deep-get with dot notation.

const myValue = store.get('deep.deeper.deepest')

Delete key

Delete a key from the state.

store.delete('myKey')

Dump data

Dump all state data. Specify true to decrypt encrypted data. False by default.

store.dump()

Clear all

Clear all entries from the state.

store.clear()

Options

Initialize state

Initialize the store with a predefined state.

const initialState = {
  foo: 'bar',
  baz: 'qux'
}

const store = new Antiflux(initialState)

Encrypt data

Encrypt data at rest with AES-256-GCM encryption. Use the encryptKey option to specify a 32-character encryption key.

const options = {
  encryptKey: 'bWDlfrMxr1cnl4F4sdOvoKEOO9WY628a'
}

const store = new Antiflux({}, options)

Persist data

Use the persist option to specify a path at which to write data. Data will be reloaded from disk at runtime.

const options = {
  persist: '/tmp/antiflux.db'
}

const store = new Antiflux({}, options)

Custom getters

Create custom getters to return modified data.

const getters = {
  getLower(state) {
    return state.get('foo.bar.baz').toLowerCase()
  },
  getUpper(state) {
    return state.get('foo.bar.baz').toUpperCase()
  }
}

const store = new Antiflux({}, {}, getters)