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
   7     var jsonpointer = require("jsonpointer");
   8     var obj = { foo: 1, bar: { baz: 2}, qux: [3, 4, 5]};
   9     var one = jsonpointer.get(obj, "/foo");
  10     var two = jsonpointer.get(obj, "/bar/baz");
  11     var three = jsonpointer.get(obj, "/qux/0");
  12     var four = jsonpointer.get(obj, "/qux/1");
  13     var five = jsonpointer.get(obj, "/qux/2");
  14     var notfound = jsonpointer.get(obj, "/quo"); // returns null
  15
  16     jsonpointer.set(obj, "/foo", 6); // obj.foo = 6;
  17
  18 ## Testing
  19
  20     $ node test.js
  21     All tests pass.
  22     $
  23
  24 [![Build Status](https://travis-ci.org/janl/node-jsonpointer.png?branch=master)](https://travis-ci.org/janl/node-jsonpointer)
  25
  26 ## Author
  27
  28 (c) 2011 Jan Lehnardt <jan@apache.org>
  29
  30 ## License
  31
  32 MIT License.