JSONPath Tools

Appearance

JSONPath Tools / @jsonpath-tools/jsonpath / Segment

Class: Segment ​

Query segment.

Extends ​

Constructors ​

new Segment() ​

ts
new Segment(
   dotToken, 
   openingBracketToken, 
   selectors, 
   closingBracketToken, 
   segmentType): Segment

Parameters ​

dotToken ​

Dot or double dot token, or null if not present.

null | SyntaxTreeToken

openingBracketToken ​

Opening bracket token, or null if not present.

null | SyntaxTreeToken

selectors ​

readonly object[]

Selectors

closingBracketToken ​

Closing bracket token, or null if not present.

null | SyntaxTreeToken

segmentType ​

SegmentType

Whether it is a child segment or a descendant segment.

Returns ​

Segment

Overrides ​

SyntaxTreeNode.constructor

Properties ​

_parent ​

ts
_parent: null | SyntaxTreeNode = null;

Internal

Inherited from ​

SyntaxTreeNode._parent

children ​

ts
readonly children: SyntaxTree[];

Children.

Inherited from ​

SyntaxTreeNode.children

closingBracketToken ​

ts
readonly closingBracketToken: null | SyntaxTreeToken;

Closing bracket token, or null if not present.

dotToken ​

ts
readonly dotToken: null | SyntaxTreeToken;

Dot or double dot token, or null if not present.

length ​

ts
readonly length: number;

Length in the text.

Inherited from ​

SyntaxTreeNode.length

openingBracketToken ​

ts
readonly openingBracketToken: null | SyntaxTreeToken;

Opening bracket token, or null if not present.

position ​

ts
readonly position: number;

Position in the text.

Inherited from ​

SyntaxTreeNode.position

segmentType ​

ts
readonly segmentType: SegmentType;

Whether it is a child segment or a descendant segment.

selectors ​

ts
readonly selectors: readonly object[];

Selectors

Accessors ​

parent ​

Get Signature ​

ts
get parent(): null | SyntaxTreeNode

Parent or null when no parent is assigned.

Returns ​

null | SyntaxTreeNode

Inherited from ​

SyntaxTreeNode.parent

skippedTextBefore ​

Get Signature ​

ts
get skippedTextBefore(): string

Text that was skipped during parsing.

Returns ​

string

Text that was skipped during parsing.

Inherited from ​

SyntaxTreeNode.skippedTextBefore

textRange ​

Get Signature ​

ts
get textRange(): TextRange

Range in the text.

Returns ​

TextRange

Inherited from ​

SyntaxTreeNode.textRange

textRangeWithoutSkipped ​

Get Signature ​

ts
get textRangeWithoutSkipped(): TextRange

Range in the text excluding skipped text before.

Returns ​

TextRange

Inherited from ​

SyntaxTreeNode.textRangeWithoutSkipped

type ​

Get Signature ​

ts
get type(): SyntaxTreeType

Type.

Returns ​

SyntaxTreeType

Type.

Overrides ​

SyntaxTreeNode.type

usesBracketNotation ​

Get Signature ​

ts
get usesBracketNotation(): boolean

Whether the segment uses a bracket notation.

Returns ​

boolean

Methods ​

forEach() ​

ts
forEach(action): void

Executes the given action for this and all descendant trees in a pre-order tree traversal.

Parameters ​

action ​

(tree) => boolean | void

Action.

Returns ​

void

Inherited from ​

SyntaxTreeNode.forEach

getAtPosition() ​

ts
getAtPosition(characterPosition): null | SyntaxTree

Returns the innermost subtree that spans the given character position or null when the position is outside of a range of the current tree.

Parameters ​

characterPosition ​

number

Position (character index).

Returns ​

null | SyntaxTree

Inherited from ​

SyntaxTreeNode.getAtPosition

getContainingAtPosition() ​

ts
getContainingAtPosition(caretPosition): null | SyntaxTree

Returns the innermost subtree that fully contains the given caret position (not just touches) or null when the position is not contained in a range of the current tree.

Parameters ​

caretPosition ​

number

Position (caret position index).

Returns ​

null | SyntaxTree

Inherited from ​

SyntaxTreeNode.getContainingAtPosition

getTouchingAtPosition() ​

ts
getTouchingAtPosition(caretPosition): SyntaxTree[]

Returns all innermost subtrees that touch the given caret position.

Parameters ​

caretPosition ​

number

Position (caret position index).

Returns ​

SyntaxTree[]

Inherited from ​

SyntaxTreeNode.getTouchingAtPosition

select() ​

ts
select(
   input, 
   output, 
   queryContext): void

Selects nodes from the input node to the output array.

Parameters ​

input ​

Node

Input node.

output ​

PushOnlyArray<Node>

Output nodes.

queryContext ​

QueryContext

Query context.

Returns ​

void