JSONPath Tools

Appearance

JSONPath Tools / @jsonpath-tools/jsonpath / SignatureHelpService

Class: SignatureHelpService ​

Provides a signature for a called function.

Constructors ​

Constructor ​

ts
new SignatureHelpService(queryOptions): SignatureHelpService;

Parameters ​

queryOptions ​

QueryOptions

Query options.

Returns ​

SignatureHelpService

Methods ​

provideSignature() ​

ts
provideSignature(query, position): Signature | null;

Provides a signature at the given caret position in the query text. When no signature is available it returns null.

Parameters ​

query ​

Query

Query.

position ​

number

Caret position in the query text (starts with 0).

Returns ​

Signature | null