JSONPath Tools

Appearance

JSONPath Tools / @jsonpath-tools/jsonpath / SliceSelector

Class: SliceSelector ​

Slice selector.

Extends ​

Constructors ​

Constructor ​

ts
new SliceSelector(
   startToken, 
   firstColonToken, 
   endToken, 
   secondColonToken, 
   stepToken, 
   start, 
   end, 
   step): SliceSelector;

Parameters ​

startToken ​

SyntaxTreeToken | null

Range start index token.

firstColonToken ​

SyntaxTreeToken

Colon token delimiting start and end tokens.

endToken ​

SyntaxTreeToken | null

Range end index token.

secondColonToken ​

SyntaxTreeToken | null

Colon token delimiting end and step tokens.

stepToken ​

SyntaxTreeToken | null

Range step token.

start ​

number | null

Range start index (inclusive).

end ​

number | null

Range end index (exclusive).

step ​

number | null

Range step.

Returns ​

SliceSelector

Overrides ​

Selector.constructor

Properties ​

_parent ​

ts
_parent: SyntaxTreeNode | null = null;

Internal

Inherited from ​

Selector._parent

children ​

ts
readonly children: SyntaxTree[];

Children.

Inherited from ​

Selector.children

end ​

ts
readonly end: number | null;

Range end index (exclusive).

endToken ​

ts
readonly endToken: SyntaxTreeToken | null;

Range end index token.

firstColonToken ​

ts
readonly firstColonToken: SyntaxTreeToken;

Colon token delimiting start and end tokens.

length ​

ts
readonly length: number;

Length in the text.

Inherited from ​

Selector.length

position ​

ts
readonly position: number;

Position in the text.

Inherited from ​

Selector.position

secondColonToken ​

ts
readonly secondColonToken: SyntaxTreeToken | null;

Colon token delimiting end and step tokens.

start ​

ts
readonly start: number | null;

Range start index (inclusive).

startToken ​

ts
readonly startToken: SyntaxTreeToken | null;

Range start index token.

step ​

ts
readonly step: number | null;

Range step.

stepToken ​

ts
readonly stepToken: SyntaxTreeToken | null;

Range step token.

Accessors ​

parent ​

Get Signature ​

ts
get parent(): SyntaxTreeNode | null;

Parent or null when no parent is assigned.

Returns ​

SyntaxTreeNode | null

Inherited from ​

Selector.parent

skippedTextBefore ​

Get Signature ​

ts
get skippedTextBefore(): string;

Text that was skipped during parsing.

Returns ​

string

Text that was skipped during parsing.

Inherited from ​

Selector.skippedTextBefore

textRange ​

Get Signature ​

ts
get textRange(): TextRange;

Range in the text.

Returns ​

TextRange

Inherited from ​

Selector.textRange

textRangeWithoutSkipped ​

Get Signature ​

ts
get textRangeWithoutSkipped(): TextRange;

Range in the text excluding skipped text before.

Returns ​

TextRange

Inherited from ​

Selector.textRangeWithoutSkipped

type ​

Get Signature ​

ts
get type(): SyntaxTreeType;

Type.

Returns ​

SyntaxTreeType

Type.

Overrides ​

Selector.type

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 ​

Selector.forEach

getAtPosition() ​

ts
getAtPosition(characterPosition): SyntaxTree | null;

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 ​

SyntaxTree | null

Inherited from ​

Selector.getAtPosition

getContainingAtPosition() ​

ts
getContainingAtPosition(caretPosition): SyntaxTree | null;

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 ​

SyntaxTree | null

Inherited from ​

Selector.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 ​

Selector.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

Overrides ​

Selector.select