json-pointer
Some utilities for JSON pointers described by RFC 6901
Provides some additional stuff i needed but is not included in node-jsonpointer
Installation
node.js
$ npm install json-pointer
API
var pointer = require('json-pointer');
.get(object, pointer)
Looks up a JSON pointer in an object.
Array of reference tokens, e.g. returned by api.parse, can be passed as a pointer to .get, .set and .remove methods.
var obj = {
example: {
bla: 'hello'
}
};
pointer.get(obj, '/example/bla');
.set(object, pointer, value)
Sets a new value on object at the location described by pointer.
var obj = {};
pointer.set(obj, '/example/bla', 'hello');
.remove(object, pointer)
Removes an attribute of object referenced by pointer.
var obj = {
example: 'hello'
};
pointer.remove(obj, '/example');
.dict(object)
Creates a dictionary object (pointer -> value).
var obj = {
hello: {bla: 'example'}
};
pointer.dict(obj);
.walk(object, iterator)
Just like:
each(pointer.dict(obj), iterator);
.has(object, pointer)
Tests if an object has a value for a JSON pointer.
var obj = {
bla: 'hello'
};
pointer.has(obj, '/bla');
pointer.has(obj, '/non/existing');
.escape(str)
Escapes a reference token.
pointer.escape('hello~bla');
pointer.escape('hello/bla');
.unescape(str)
Unescape a reference token.
pointer.unescape('hello~0bla');
pointer.unescape('hello~1bla');
.parse(str)
Converts a JSON pointer into an array of reference tokens.
pointer.parse('/hello/bla');
.compile(array)
Builds a json pointer from an array of reference tokens.
pointer.compile(['hello', 'bla']);
pointer(object, [pointer, [value]])
Convenience wrapper around the api.
pointer(object)
pointer(object, pointer)
pointer(object, pointer, value)
The wrapper supports chainable object oriented style.
var obj = {anything: 'bla'};
var objPointer = pointer(obj);
objPointer.set('/example', 'bla').dict();