Skip to main content

Type Alias: JSONPathEnvironmentOptions

JSONPathEnvironmentOptions = object

Defined in: src/path/environment.ts:17

JSONPath environment options. The defaults are in compliance with JSONPath standards.

Properties​

maxExpressionDepth?​

optional maxExpressionDepth?: number

Defined in: src/path/environment.ts:46

The maximum number of nested expressions allowed in a query before a JSONPathRecursionError is thrown.

maxIntIndex?​

optional maxIntIndex?: number

Defined in: src/path/environment.ts:34

The maximum integer allowed when indexing or slicing an array. Defaults to 2**53 -1.

maxRecursionDepth?​

optional maxRecursionDepth?: number

Defined in: src/path/environment.ts:52

The maximum number of objects and/or arrays the descendant segment can visit before a JSONPathRecursionError is thrown.

minIntIndex?​

optional minIntIndex?: number

Defined in: src/path/environment.ts:40

The minimum integer allowed when indexing or slicing an array. Defaults to -(2**53) -1.

parser?​

optional parser?: ParserClass

Defined in: src/path/environment.ts:57

The JSONPath parser to use. Currently there's only one parser.

strict?​

optional strict?: boolean

Defined in: src/path/environment.ts:28

Indicates if the environment should to be strict about its compliance with RFC 9535.

Defaults to true. Setting strict to false enables non-standard features. Non-standard features are subject to change if conflicting features are included in a future JSONPath standard or draft standard, or an overwhelming consensus amongst the JSONPath community emerges that differs from this implementation.