https://github.com/alexeykuzmin/jsonpointer.js

JavaScript implementation of JSON Pointer
https://github.com/alexeykuzmin/jsonpointer.js

json json-pointer

Last synced: about 1 month ago
JSON representation

JavaScript implementation of JSON Pointer

• Host: GitHub
• URL: https://github.com/alexeykuzmin/jsonpointer.js
• Owner: alexeykuzmin
• License: mit
• Created: 2013-04-08T20:20:35.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2020-10-01T04:42:13.000Z (almost 4 years ago)
• Last Synced: 2024-05-12T10:20:34.425Z (about 2 months ago)
• Topics: json, json-pointer
• Language: JavaScript
• Homepage:
• Size: 47.9 KB
• Stars: 32
• Watchers: 2
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• ?utm_source=awesome-jsonschema - jsonpointer.js

README

        
# JavaScript JSON Pointer

[![Build Status](https://travis-ci.org/alexeykuzmin/jsonpointer.js.png)](https://travis-ci.org/alexeykuzmin/jsonpointer.js)

[![Dependency Status](https://gemnasium.com/alexeykuzmin/jsonpointer.js.png)](https://gemnasium.com/alexeykuzmin/jsonpointer.js)

[![NPM Version](https://badge.fury.io/js/jsonpointer.js.png)](https://npmjs.org/package/jsonpointer.js)

JavaScript implementation of JSON Pointer ([RFC 6901](http://tools.ietf.org/html/rfc6901)).  

Can be used as Node.js package, AMD module or a plain script.

## Installation

via [npm](https://npmjs.org/):

    $ npm install jsonpointer.js

    

via [Bower](http://twitter.github.io/bower/):

    $ bower install jsonpointer.js

    

or copy `src/jsonpointer.js` file from repo.

## Include

###Node.js

```js

var jsonpoiner = require('jsonpointer.js');  // XXX: '.js' is part of package name!

console.log(typeof jsonpointer);  // 'object'

```

###[AMD](https://github.com/amdjs/amdjs-api/wiki/AMD)

```js

require('jsonpointer', function(jsonpointer) {

  console.log(typeof jsonpointer);  // 'object'

});

```

### <script> tag

```html

   console.log(typeof window.jsonpointer);  // 'object'

```

## API

### jsonpointer.get

`get()` accepts strings, objects and arrays as evaluation target.

```js

var target = {

  foo: {

    bar: 'foobar'

  },

  baz: [true, false],

  '~': 'tilde',

  '/': 'slash'

});

var targetJSON = JSON.stringify(target);

jsonpointer.get(target, '/foo');  // {bar: 'foobar'}

jsonpointer.get(target, '/foo/bar');  // 'foobar'

jsonpointer.get(target, '/some/nonexisting/path');  // undefined

jsonpointer.get(target, '/~0');  // 'tilde'

jsonpointer.get(targetJSON, '/~1');  // 'slash'

jsonpointer.get(targetJSON, '/baz');  // [true, false]

jsonpointer.get(targetJSON, '/baz/0');  // true

jsonpointer.get(targetJSON, '/baz/2');  // undefined

```

Second argument might be omitted, in such case `get()` returns a function

that takes pointer as argument and evaluates it.

```js

var evaluate = jsonpointer.get(target);

evaluate('/foo/bar');  // 'foobar'

```

There are several cases when `.get()` throws an exception:

 - First argument is not string, object or array.

 - First argument is string but is not valid JSON string.

 - Seconds argument is not valid JSON Pointer string.

 - Unacceptable token met during evaluation (check [section 4 of spec](http://tools.ietf.org/html/rfc6901#section-4) for examples).

 - `'-'` token used in JSON Pointer string and it's going to be evaluated in `Array` context.