JSONPath Tools

Appearance

JSONPath Tools / @jsonpath-tools/jsonpath / Signature

Class: Signature ​

Signature.

Constructors ​

new Signature() ​

ts
new Signature(
   text, 
   parameters, 
   activeParameterIndex, 
   documentation): Signature

Parameters ​

text ​

string

Text.

parameters ​

readonly SignatureParameter[]

Parameters.

activeParameterIndex ​

number

Index of a parameter from parameters where the caret is.

documentation ​

string

Documentation. In Markdown format.

Returns ​

Signature

Properties ​

activeParameterIndex ​

ts
readonly activeParameterIndex: number;

Index of a parameter from parameters where the caret is.

documentation ​

ts
readonly documentation: string;

Documentation. In Markdown format.

parameters ​

ts
readonly parameters: readonly SignatureParameter[];

Parameters.

text ​

ts
readonly text: string;

Text.