Namespace: Versionizable

BeautifulProperties. Versionizable

Source:

Classes

Transaction
Version

Methods

(static) define(object, key, optionsopt)

This method can be use after Hookable.define.
Parameters:
Name Type Attributes Description
object object
key string
options Object <optional>
 length's default value is 2.
Source:
See:

(static) getHistoryLength(object, key) → {number}

Parameters:
Name Type Description
object object
key string
Source:
Returns:
Type
number

(static) getPreviousValue(object, key) → {*}

Parameters:
Name Type Description
object object
key string
Source:
Returns:
Type
*

(static) getVersion(object, key, index) → {BeautifulProperties.Versionizable.Version}

Parameters:
Name Type Description
object object
key string
index number
Source:
Returns:
Type
BeautifulProperties.Versionizable.Version

(static) getVersions(object, key) → {Array.<BeautifulProperties.Versionizable.Version>}

Parameters:
Name Type Description
object object
key string
Source:
Returns:
Type
Array.<BeautifulProperties.Versionizable.Version>

(static) transaction(object, key, callback, doneCallbackopt)

The method modify property's history.
It's experimental API.
Parameters:
Name Type Attributes Description
object object
key string
callback BeautifulProperties.Versionizable~transactionCallback
doneCallback BeautifulProperties.Versionizable~doneCallback <optional>
Source:

(static) undo(object, key, version)

Parameters:
Name Type Description
object object
key string
version BeautifulProperties.Versionizable.Version
Source:

Type Definitions

doneCallback(currentVersion, versions, currentVersionBeforeTransaction, versionsBeforeTransaction)

Parameters:
Name Type Description
currentVersion BeautifulProperties.Versionizable.Version
versions Array.<BeautifulProperties.Versionizable.Version>
currentVersionBeforeTransaction BeautifulProperties.Versionizable.Version
versionsBeforeTransaction Array.<BeautifulProperties.Versionizable.Version>
Source:

transactionCallback(versions)

This:
Parameters:
Name Type Description
versions Array.<BeautifulProperties.Versionizable.Version>
Source: