Decoy


Create Proxy objects and keep track of mutations, reflecting them on access and providing the ability to either commit them or roll them back.

A word of caution

Decoy can only keep track of direct property changes, this means that any decoy target that works solely through getters/setters will directly influence the underlying target. A good example is the built-in Date object, which is modified using its setter methods (e.g. setFullYear(2018)).

Installation

Decoy is a scoped package, which means both the installation and require (or import) need the scope along with the package name:

``
$ npm install --save @konfirm/decoy
`

Usage

`ts
// require Decoy
import * as Decoy from '@konfirm/decoy';
// create the original object
const original = { foo: 'bar', baz: { hello: 'world' }};
// create the decoy dummy for original
const dummy = Decoy.create(original);

console.log(dummy.foo); // 'bar'
console.log(original.foo); // 'bar';

dummy.foo = 'I pity the foo!';

console.log(dummy.foo); // 'I pity the foo!';
console.log(original.foo); // 'bar';

Decoy.commit(dummy)
.then((result) => {
console.log(result === original); // true
console.log(dummy.foo); // 'I pity the foo!';
console.log(original.foo); // 'I pity the foo!';
});
`

API


Decoy is a collection of individual functions that work with any object that can to be proxied.
All direct property changes are recorded to be truly applied (commit) or reverted (rollback) at a later stage. The created proxy decoys will reflect the changes made.

$3

| name | syntax | description |
| ------------ | ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| Decoy | Decoy