Class RegexFilter<T>

A filter which work with regexes

Type parameters

T: Types

Hierarchy

RegexFilter

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RegexFilter<T>(path: string, filter: Filter<Document<T>>, expr: Record<string, unknown>): RegexFilter<T>

- Defined in query/RegExp.ts:11
Type parameters
- T: unknown
Parameters
- path: string
- filter: Filter<Document<T>>
- expr: Record<string, unknown>
Returns RegexFilter<T>

Properties

Protected Readonly expr

expr: Record<string, unknown>

Protected Readonly filter

filter: Filter<Document<T>>

Protected Readonly path

path: string

Methods

compare

compare(operator: "$eq" | "$ne", regex: RegExp): Match<T>

- Defined in query/RegExp.ts:32
Filter if the comparison return true

Parameters
- operator: "$eq" | "$ne"
- regex: RegExp
Returns Match<T>

equal

equal(regex: RegExp): Match<T>

- Defined in query/RegExp.ts:22
Filter if regex is equal

Parameters
- regex: RegExp
Returns Match<T>

notEqual

notEqual(regex: RegExp): Match<T>

- Defined in query/RegExp.ts:27
Filter if regexis not equal

Parameters
- regex: RegExp
Returns Match<T>

Generated using TypeDoc