Skip to content

JSONPath Tools / @jsonpath-tools/jsonpath / Function

Interface: Function

JSONPath function.

Properties

description

ts
readonly description: string;

Description. In Markdown format.


handler

ts
readonly handler: FunctionHandler;

JavaScript function that implements the JSONPath function.


parameters

ts
readonly parameters: readonly FunctionParameter[];

List of function parameters.


returnDataType

ts
readonly returnDataType: DataType;

Return data type.


returnType

ts
readonly returnType: Type;

Return type.