object-history

object-history

JavaScript Object history

Behind the scenes

For cloning, UltraDeepClone. For diff/apply, changeset.

Old browsers

Works in IE8 with es5-shim. Perhaps IE7, as well.

Constructor

History

Gives birth to instances

• initial {Object}: The initial history point
• options {Object}: Optional options

var History = require('object-history')
var initial = {foo: 'bar', name: 'victoria'}
var history = new History(initial)

Constructor options

limit Optional. Provide a number of backwards history points to keep. Older than this number will be forgotten and hopefully their allocated memory will be reclaimed.

Methods

add

Add a history point object

• obj {Object}: The history point

history.add({
  foo: 'bar',
  bar: 'foo'
})

backward

Go back one history point](./lib/prototype/backward.js#L11)

forward

Go forward one history point

get

• returns {Object}: "Current" history point

Get the "current" history point

lengthBackward

• returns {Number}: Number of history points backwards

lengthForward

• returns {Number}: Number of history points forward

Copyright

Copyright © 2015 PolicyStat LLC