Transactor

Transactor is a simple library that helps to keep track of local transactional changes to data.

Start Here

install

npm i --save sequence-transactor

include transactor in your project

import sequenceTransactor from 'sequence-transactor'

use it

let transactor = sequenceTransactor.create();

add transactions

id = 1;

transactor.add(id, {id, value: 'test'}); transactor.add(id, {id, value: 'test change'}); transactor.add(id, {id, value: 'test change three'});

get transaction data

let data = transactor.get();

expected data [ {id, value: 'test'}, {id, value: 'test change'}, {id, value: 'test change three'}, ]

get latest edge data

let data = transaction.getLatest();

expected data [ {id, value: 'test change three'}, ]

getLatest uses the id param to group data. for example

transactor.add(1, {id: 1, value: 'test'}); transactor.add(1, {id: 2, value: 'test change'}); transactor.add(1, {id: 3, value: 'test change three'});

these are seen by transactor as a single piece of data with multiple transactions. while this.

transactor.add(1, {id: 1, value: 'test'}); transactor.add(2, {id: 1, value: 'test change'}); transactor.add(3, {id: 1, value: 'test change three'});

is seen as 3 pieces of data, each with one transaction.

save data -- all save functions expect work to return a promise, and return a promise.all that resolves when all work promsies resolve

let saveFunction = console.log;

transactor.save(saveFunction)

this will call console.log one time with an array of data to save. [ {id: 1, value: 'test'}, {id: 1, value: 'test change'}, {id: 1, value: 'test change two'}, ]

save latest edge only

if you only want to make calls for the latest edge data you can use.

transactor.saveEdge(saveFunction)

this will call console.log one time with [ {id: 1, value: 'test change two'}, ]

Overview!

Transactor creates and manages client side transactions, allowing you to then opperate on them individualy or as a whole. For example, you could create a transaction for adding several new users to a form, then save them all at once. Additionaly, Transactor gives access to the transactions and provides methods to super impose the transactions on an existing data set, it allows undo and redo features, and can differntiate between saveable and non saveable transactions. Lastly each instantiation of Transactor keys its transactions uniquely, meaning you can have multiple transctor instance at once.

You can

• Save a sequence of changes to the same set of data
• Create saveable and unsaveable changes
  • Saveable changes will be given to the save handler, where is unsaveable will be ignored and only used locally.
• Undo changes
• Redo changes
• Create 1 or more instances to track 1 or more sets of changes