npm

Bring the best of OSS JavaScript development to your projects with npm Orgs - private packages & team management tools.Learn more »

enrich-js

0.1.6 • Public • Published

Enrich.js

A library for "enriching" JavaScript objects and arrays with flexible change-tracking, event, and undo/redo functionality.

Installation

npm install enrich-js --save

Usage

Consider this JavaScript object:

var obj = {
  name: 'Matt',
  details: {
    age: 22,
    eyes: 'blue',
    hair: 'brown'
  }
};

This can be "enriched" to give it extra functionality:

obj = enrich(obj);

We can add some handlers for default "change", "undo" and "redo" events, or for custom events. Here we will add handlers for the default events and use the built-in event-to-string functions:

obj.on('change', function (data) {
  console.log(obj.stringFromChangeEvent(data));
});
obj.on('undo', function (data) {
  console.log(obj.stringFromUndoEvent(data));
});
obj.on('redo', function (data) {
  console.log(obj.stringFromRedoEvent(data));
});

Now we can test them by making some changes and then doing a few undos and redos:

obj.name = 'Matthew';
obj.details.age++;
 
//Console readout:
//this.name changed from "Matt" to "Matthew"
//this.details.age changed from 22 to 23
 
obj.undo().undo().redo(); //Note the function chaining
 
//Console readout:
//this.details.age undone from 23 to 22
//this.name undone from "Matthew" to "Matt"
//this.name redone from "Matt" to "Matthew"

Contribution

This was primarily created as an exercise for practicing prototypal and functional JavaScript principles. There are currently still a few issues including errors when undoing array methods and is a work in progress. However, I can certainly see a few useful applications in web-based editors and similar scenarios where there is large user input.

Release History

  • 0.1 Initial release

install

npm i enrich-js

Downloadsweekly downloads

14

version

0.1.6

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability