Class: Match

jsonpath.functions.Match

A JSONPath filter function definition.

Implements

• FilterFunction

Constructors

constructor

• new Match(options?): Match

Parameters

Name	Type
options	MatchFilterFunctionOptions

Returns

Match

Defined in

src/path/functions/match.ts:45

Properties

#cache

• Private #cache: LRUCache<string, RegExp>

Defined in

src/path/functions/match.ts:43

---

argTypes

• Readonly argTypes: FunctionExpressionType[]

Argument types expected by the filter function.

Implementation of

FilterFunction.argTypes

Defined in

src/path/functions/match.ts:33

---

cacheSize

• Readonly cacheSize: number

Defined in

src/path/functions/match.ts:40

---

iRegexpCheck

• Readonly iRegexpCheck: boolean

Defined in

src/path/functions/match.ts:42

---

options

• Readonly options: MatchFilterFunctionOptions = {}

Defined in

src/path/functions/match.ts:45

---

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/match.ts:38

---

throwErrors

• Readonly throwErrors: boolean

Defined in

src/path/functions/match.ts:41

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/match.ts:53

---

fullMatch

▸ fullMatch(pattern): string

Parameters

Name	Type
pattern	string

Returns

string

Defined in

src/path/functions/match.ts:94