Class: Search

jsonpath.functions.Search

A JSONPath filter function definition.

Implements

• FilterFunction

Constructors

constructor

• new Search(options?): Search

Parameters

Name	Type
options	SearchFilterFunctionOptions

Returns

Search

Defined in

src/path/functions/search.ts:46

Properties

#cache

• Private #cache: LRUCache<string, RegExp>

Defined in

src/path/functions/search.ts:44

---

argTypes

• Readonly argTypes: FunctionExpressionType[]

Argument types expected by the filter function.

Implementation of

FilterFunction.argTypes

Defined in

src/path/functions/search.ts:34

---

cacheSize

• Readonly cacheSize: number

Defined in

src/path/functions/search.ts:41

---

iRegexpCheck

• Readonly iRegexpCheck: boolean

Defined in

src/path/functions/search.ts:43

---

options

• Readonly options: SearchFilterFunctionOptions = {}

Defined in

src/path/functions/search.ts:46

---

returnType

• Readonly returnType: LogicalType = FunctionExpressionType.LogicalType

The type of the value returned by the filter function.

Implementation of

FilterFunction.returnType

Defined in

src/path/functions/search.ts:39

---

throwErrors

• Readonly throwErrors: boolean

Defined in

src/path/functions/search.ts:42

Methods

call

▸ call(s, pattern): boolean

A function with unknown number and type of arguments.

Parameters

Name	Type
s	string
pattern	string

Returns

boolean

Implementation of

FilterFunction.call

Defined in

src/path/functions/search.ts:54