import JSONPointer from 'vulp/src/JSONPointer/index.js'

public class | source

JSONPointer

JSON Pointer defines a string format for identifying a specific value within a JSON document.

This class holds methods for manipulation of pointers.

For more information:

Static Method Summary

Static Public Methods
public static	ofString(str: string): JSONPointer parse str and return JSONPointer
public static	ofTokens(tokens: ):

Constructor Summary

Public Constructor
public	constructor(opts: Object) JSONPointer constructors

Member Summary

Public Members
public	tokens: *

Method Summary

Public Methods
public	concat(sub: JSONPointer): JSONPointer concat two JSONPointer
public	first(): string get first token
public	last(): string get last token
public	size(): number return length of token array
public	slice(): JSONPointer slice JSONPointer
public	toImmutable(): string get immutable js string representation
public	toRFC(): string get rfc string representation

Static Public Methods

public static ofString(str: string): JSONPointer source

parse str and return JSONPointer

If x starts with '/' create will treat x as a JSONPointer. All other string will be treated like immutable js pointer (eg.: 'foo.bar')

Params:

Name	Type	Attribute	Description
str	string		pointer string

Return:

JSONPointer

public static ofTokens(tokens: ): source

Params:

Name	Type	Attribute	Description
tokens	*

Return:

Public Constructors

public constructor(opts: Object) source

JSONPointer constructors

Params:

Name	Type	Attribute	Description
opts	Object		options.
opts.tokens	TokenList		json path tokens

Public Members

public tokens: * source

Public Methods

public concat(sub: JSONPointer): JSONPointer source

concat two JSONPointer

Params:

Name	Type	Attribute	Description
sub	JSONPointer		the pointer to concat

Return:

JSONPointer

public first(): string source

get first token

Return value is the first entry from token list.

Return:

string

public last(): string source

get last token

Return value is the last entry from token list.

Return:

string

public size(): number source

return length of token array

Return:

number

public slice(): JSONPointer source

slice JSONPointer

slice has the same signature like Array.prototype.slice.

Return:

JSONPointer

public toImmutable(): string source

get immutable js string representation

Return:

string

public toRFC(): string source

get rfc string representation

Return:

string

JSONPointer

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Static Public Methods

public static ofString(str: string): JSONPointer source

Params:

Return:

public static ofTokens(tokens: *): * source

Params:

Return:

Public Constructors

public constructor(opts: Object) source

Params:

Public Members

public tokens: * source

Public Methods

public concat(sub: JSONPointer): JSONPointer source

Params:

Return:

public first(): string source

Return:

public last(): string source

Return:

public size(): number source

Return:

public slice(): JSONPointer source

Return:

public toImmutable(): string source

Return:

public toRFC(): string source

Return:

public static ofTokens(tokens: ): source