www.aleph1.co.uk Git - yaffs-website/blob - node_modules/jsonpointer/README.md

   1 # JSON Pointer for nodejs
   2
   3 This is an implementation of [JSON Pointer](http://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-08).
   4
   5 ## Usage
   6 ```javascript
   7 var jsonpointer = require('jsonpointer');
   8 var obj = { foo: 1, bar: { baz: 2}, qux: [3, 4, 5]};
   9
  10 jsonpointer.get(obj, '/foo');     // returns 1
  11 jsonpointer.get(obj, '/bar/baz'); // returns 2
  12 jsonpointer.get(obj, '/qux/0');   // returns 3
  13 jsonpointer.get(obj, '/qux/1');   // returns 4
  14 jsonpointer.get(obj, '/qux/2');   // returns 5
  15 jsonpointer.get(obj, '/quo');     // returns undefined
  16
  17 jsonpointer.set(obj, '/foo', 6);  // sets obj.foo = 6;
  18 jsonpointer.set(obj, '/qux/-', 6) // sets obj.qux = [3, 4, 5, 6]
  19
  20 var pointer = jsonpointer.compile('/foo')
  21 pointer.get(obj)    // returns 1
  22 pointer.set(obj, 1) // sets obj.foo = 1
  23 ```
  24
  25 ## Testing
  26
  27     $ node test.js
  28     All tests pass.
  29     $
  30
  31 [![Build Status](https://travis-ci.org/janl/node-jsonpointer.png?branch=master)](https://travis-ci.org/janl/node-jsonpointer)
  32
  33 ## Author
  34
  35 (c) 2011-2015 Jan Lehnardt <jan@apache.org> & Marc Bachmann <https://github.com/marcbachmann>
  36
  37 ## License
  38
  39 MIT License.