A way to
append only objects (deltas) to objects
| Added some modifications to be aligned with Peer DID method specification.
- The target object is not mutated
- The initial values can be set without
idto be undeletables
idis added to all the objects appended if no
deleteany object by his
appendatomatically a timestamp setting
appenddeep equal object to an array,
appendan object with an id already deleted
npm install append-only-object --save
const me = name: 'javi'mememeconst addSecondChildren = memememename = 'noop'delete menamemewife = nullmechildrens0value = 'noop'mechildrensconsoleconsoleconsole
name: 'Javi'surname: id: 'surname' value: 'Santos'wife: 'Sam'childrens:value: 'Adam' id: 'uoNymdl6Q3W6vO-xL-Kwkw-2'value: 'Matt' id: 'second'Set 'error'change: childrens: Objectby: '1a75a182-9f48-4a18-bd1e-fea4b7f19e67'when: '2020-06-25T12:40:52.430Z'patch: op: 'add' path: '/childrens/1' value: Object
See tests and example.js for more info.
new AppendOnlyObject(target, [options])
This class creates an append only object, where you can only
target is the initial object.
options to control the object returned by the
append method, include:
strict: true // set to false if you want to be able to `modify` (without overwrite or delete) an object or array (ex. push to an array or add a prop to an existent object).unique: true // set to false if you want to allow objects with the same id.encode: false // to encode the `change` value. Other options json|base64url|base64|hex|binaryby: false // Can send an `string`, `object` or `array`.when: false // add an (ISO 8601) `when` value.patch: false // set to true if you want a (RFC6902) `patch` object tu be returned.previous: false // set to true to receive the `previous` object before the append.
| All the
options can be set
globally in the creation of the object or with more
unique) in the
This method appends the delta to an already created
The id can be a
string or an
array of strings.
Removes all matching object with this id. Adds the id to the AppendOnlyObject
.deleted (the property is hidden, and is an iterable
npm installnpm run test
Copyright (c) 2020 Javi Santos
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.