jbro885 / js-pointer

Implementation of the JSON Pointer RFC 6901 spec

js-pointer

Tiny, spec compliant implementation of the JSON Pointer spec RFC 6901 with 100% test coverage and no dependencies.

Getting started

Install via NPM

  npm i js-pointer --save

Point to object properties

const jsPointer = require('js-pointer');

const object = { one: { two: 3 } }
jsPointer.get(object, '/one/two')
// → 3

Pointing to array elements

const object = { one: { two: [3] } }
jsPointer.get(object, '/one/two/0')
// → 3

Pointing through array elements

const object = { one: { two: [{ three: 4 }] } }
jsPointer.get(object, '/one/two/0/three')
// → 4

Please see the spec and tests for further detail of the JSON pointer format.

API

jsPointer.get(object, pointer)

Returns sub-object or value in object referred to by pointer. If pointer does not refer to an object or value then undefined will be returned.

object

Plain object targeted by the pointer

pointer

string JSON pointer. A pointer beginning with # indicates a URI fragment, which will be URI decoded before processing.