jsondiff-share-ops

0.0.1 • Public • Published

jsondiff-share-ops

Get differences from two JSON stucture as operations in ShareJS JSON OT format. The lib uses the great JSONDiffPatch package to get differences. ShareJS JSON OT format is explained here: https://github.com/share/ottypes/wiki/JSON-operations (There isn't support for number or string operations yet.)

Install

$ npm install jsondiff-share-ops

Usage

var jsondiff = require('jsondiff-share-ops');
 
var first = {
    a: 'same',
    b: [1, 2, 3],
    c: 'replace',
    d: 'remove'
}
 
var second = {
    a: 'same',
    b: [2, 1, 3],
    c: [0, 1]
}
 
var ops = jsondiff.diff(first, second);
/* ops will be : 
  [
    { p: [ 'b', 1 ], lm: 0 }, // list move operation
   { p: [ 'c' ], od: 'replace', oi: [ 0, 1 ] }, // replace operation
   { p: [ 'd' ], od: 'remove' } // remove operation
  ]
 */

TODO

  • Handle string diff operations as well
  • Handle number diff operations as well

License

(The MIT License)

Copyright (c) 2013 adig

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.

Readme

Keywords

none

Package Sidebar

Install

npm i jsondiff-share-ops

Weekly Downloads

3

Version

0.0.1

License

MIT

Last publish

Collaborators

  • adig