Skip to content

Commit 781cdd0

Browse files
committed
Add jsonpointer.compile to README
1 parent c9b54af commit 781cdd0

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

README.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,24 @@
33
This is an implementation of [JSON Pointer](http://tools.ietf.org/html/draft-ietf-appsawg-json-pointer-08).
44

55
## 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;
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 null
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+
pointer = jsonpointer.compile('/foo')
21+
pointer.get(obj) // returns 1
22+
pointer.set(obj, 1) // sets obj.foo = 1
23+
```
1724

1825
## Testing
1926

0 commit comments

Comments
 (0)