timed-state-chain v1.1.1

timed-state-chain

An unnecessary debugging library for Javascript.

Description

timed-state-chain is a library that allows you to watch how a variable changes over time. We've used a simple blockchain algorithm to ensure a secure, maintained state with the option for lookback over time.

Usage

Importing and instantiating the Block class:

var Block = require('timed-state-chain').Block;

var blockchain = new Block({abc: 123});

Getting the current state:

console.log(blockchain.getCurrentState()); // { abc: 123 }
console.log(blockchain.getCurrentStateOf('abc')); // 123
console.log(blockchain.getCurrentStateOf('differentKey')); // undefined

Mutating the state:

//Pushing a state with a new key does not change the old key's value.
blockchain.push({differentKey: 'Different value!'});
console.log(blockchain.getCurrentStateOf('abc')); // 123
console.log(blockchain.getCurrentStateOf('differentKey')); // 'Different value!'

//Pushing a new value for the old key changes the value.
blockchain.push({abc: 111});
console.log(blockchain.getCurrentStateOf('abc')); // 111
console.log(blockchain.getCurrentStateOf('differentKey')); // 'Different value!'
console.log(blockchain.getCurrentStateOf('thirdKey')); // undefined

Validating the chain:

//Unchanged chains are valid.
console.log(blockchain.isValid()); // true

//Changing the state of any segment of the chain invalidates it.
blockchain.getCurrentState().abc = 'Tampering with the data!';
console.log(blockchain.isValid()); // false

Methods

The Block class provides a number of methods to interface with the state as it transitions over time.