@types/json-pointer

What is @types/json-pointer?

@types/json-pointer provides TypeScript type definitions for the json-pointer library, which allows you to manipulate JSON data using JSON Pointers as defined in RFC 6901.

What are @types/json-pointer's main functionalities?

Get a value from a JSON object using a JSON Pointer

This feature allows you to retrieve a value from a JSON object using a JSON Pointer string.

const jsonPointer = require('json-pointer');
const obj = { foo: { bar: 'baz' } };
const value = jsonPointer.get(obj, '/foo/bar');
console.log(value); // 'baz'

Set a value in a JSON object using a JSON Pointer

This feature allows you to set a value in a JSON object at the location specified by a JSON Pointer string.

const jsonPointer = require('json-pointer');
const obj = { foo: { bar: 'baz' } };
jsonPointer.set(obj, '/foo/bar', 'qux');
console.log(obj.foo.bar); // 'qux'

Remove a value from a JSON object using a JSON Pointer

This feature allows you to remove a value from a JSON object at the location specified by a JSON Pointer string.

const jsonPointer = require('json-pointer');
const obj = { foo: { bar: 'baz' } };
jsonPointer.remove(obj, '/foo/bar');
console.log(obj.foo.bar); // undefined

Create a JSON Pointer from an array of tokens

This feature allows you to create a JSON Pointer string from an array of tokens.

const jsonPointer = require('json-pointer');
const pointer = jsonPointer.compile(['foo', 'bar']);
console.log(pointer); // '/foo/bar'

Parse a JSON Pointer into an array of tokens

This feature allows you to parse a JSON Pointer string into an array of tokens.

const jsonPointer = require('json-pointer');
const tokens = jsonPointer.parse('/foo/bar');
console.log(tokens); // ['foo', 'bar']

Other packages similar to @types/json-pointer

jsonpath

jsonpath is a query language for JSON, similar to XPath for XML. It allows for more complex queries and manipulations compared to json-pointer, which is more straightforward and adheres strictly to the JSON Pointer specification.

json-query

json-query allows for querying and manipulating JSON data using a simple query language. It provides more flexibility and functionality compared to json-pointer, which is more focused on the JSON Pointer standard.

json-ptr

json-ptr is another library for JSON Pointer operations. It offers similar functionalities to json-pointer but with a different API design. It also provides additional features like pointer validation.

README

Installation

npm install --save @types/json-pointer

Summary

This package contains type definitions for json-pointer (https://github.com/manuelstofer/json-pointer).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/json-pointer.

Additional Details

• Last updated: Tue, 07 Nov 2023 03:09:37 GMT
• Dependencies: none

Credits

These definitions were written by Bart van der Schoor, and BendingBender.