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

``bash
$ npm install json-pointer
`

API

`Javascript
var pointer = require('json-pointer');
`

$3

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.

`Javascript
var obj = {
example: {
bla: 'hello'
}
};
pointer.get(obj, '/example/bla');
`

$3

Sets a new value on object at the location described by pointer.

`Javascript
var obj = {};
pointer.set(obj, '/example/bla', 'hello');
`

$3

Removes an attribute of object referenced by pointer.

`Javascript
var obj = {
example: 'hello'
};
pointer.remove(obj, '/example');
// obj -> {}
`

$3

Creates a dictionary object (pointer -> value).

`Javascript
var obj = {
hello: {bla: 'example'}
};
pointer.dict(obj);

// Returns:
// {
// '/hello/bla': 'example'
// }
`

$3

Just like:

`Javascript
each(pointer.dict(obj), iterator);
`

$3

Tests if an object has a value for a JSON pointer.

`Javascript
var obj = {
bla: 'hello'
};

pointer.has(obj, '/bla'); // -> true
pointer.has(obj, '/non/existing'); // -> false
`

$3

Escapes a reference token.

`Javascript
pointer.escape('hello~bla'); // -> 'hello~0bla'
pointer.escape('hello/bla'); // -> 'hello~1bla'
`

$3

Unescape a reference token.

`Javascript
pointer.unescape('hello~0bla'); // -> 'hello~bla'
pointer.unescape('hello~1bla'); // -> 'hello/bla'
`

$3

Converts a JSON pointer into an array of reference tokens.

`Javascript
pointer.parse('/hello/bla'); // -> ['hello', 'bla']
`

$3

Builds a json pointer from an array of reference tokens.

`Javascript
pointer.compile(['hello', 'bla']); // -> '/hello/bla'
`

$3

Convenience wrapper around the api.

`Javascript
pointer(object) // bind object
pointer(object, pointer) // get
pointer(object, pointer, value) // set
`

The wrapper supports chainable object oriented style.

`Javascript
var obj = {anything: 'bla'};
var objPointer = pointer(obj);
objPointer.set('/example', 'bla').dict();
``