Skip to main content

Class: JSONPointer

Defined in: src/pointer/pointer.ts:20

Identify a single value in JSON-like data, as per RFC 6901.

Constructors​

new JSONPointer()​

new JSONPointer(pointer): JSONPointer

Defined in: src/pointer/pointer.ts:27

Parameters​

pointer​

string

A string representation of a JSON Pointer.

Returns​

JSONPointer

Properties​

tokens​

tokens: string[]

Defined in: src/pointer/pointer.ts:22

Methods​

exists()​

exists(value): boolean

Defined in: src/pointer/pointer.ts:239

Return true if this pointer can be resolved against value.

Note that JSONPointer.resolve() can return legitimate falsy values that form part of the target JSON document. This method will return true if a falsy value is found.

Parameters​

value​

JSONValue

Returns​

boolean

getItem()​

protected getItem(val, token, idx): JSONValue

Defined in: src/pointer/pointer.ts:139

Parameters​

val​

JSONValue

token​

string

idx​

number

Returns​

JSONValue

isRelativeTo()​

isRelativeTo(pointer): boolean

Defined in: src/pointer/pointer.ts:116

Return true if this pointer points to a child of pointer.

Parameters​

pointer​

JSONPointer

Returns​

boolean

join()​

join(...tokens): JSONPointer

Defined in: src/pointer/pointer.ts:219

Join this pointer with tokens.

Parameters​

tokens​

...string[]

JSON Pointer strings, possibly without leading slashes. If a token or "part" does have a leading slash, the previous pointer is ignored and a new JSONPointer is created, then processing of the remaining tokens continues.

Returns​

JSONPointer

A new JSON Pointer that is the concatenation of all tokens or "parts".

parent()​

parent(): JSONPointer

Defined in: src/pointer/pointer.ts:256

Return this pointer's parent as a new JSONPointer.

If this pointer points to the document root, this is returned.

Returns​

JSONPointer

parse()​

protected parse(pointer): string[]

Defined in: src/pointer/pointer.ts:125

Parameters​

pointer​

string

Returns​

string[]

resolve()​

resolve(value, fallback): JSONValue

Defined in: src/pointer/pointer.ts:56

Resolve this pointer against JSON-like data value.

Parameters​

value​

JSONValue

The target JSON-like value, possibly loaded using JSON.parse().

fallback​

MaybeJSONValue = UNDEFINED

A default value to return if value has no path matching pointer.

Returns​

JSONValue

The value identified by pointer or, if given, the fallback value in the even of a JSONPointerResolutionError.

Throws​

JSONPointerResolutionError If the value pointed to by pointer does not exist in value, and no fallback value is given.

resolveWithParent()​

resolveWithParent(value): [MaybeJSONValue, MaybeJSONValue]

Defined in: src/pointer/pointer.ts:78

Parameters​

value​

JSONValue

Returns​

[MaybeJSONValue, MaybeJSONValue]

to()​

to(rel): JSONPointer

Defined in: src/pointer/pointer.ts:266

Parameters​

rel​

string | RelativeJSONPointer

Returns​

JSONPointer

toString()​

toString(): string

Defined in: src/pointer/pointer.ts:109

Returns​

string

encode()​

static encode(tokens): string

Defined in: src/pointer/pointer.ts:32

Parameters​

tokens​

string[]

Returns​

string