Class StrFilter<T>

A filter which work with strings

Type parameters

T: Types

Hierarchy

StrFilter

Index

Constructors

constructor

Properties

Accessors

length

Methods

Constructors

constructor

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

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

Properties

Protected Readonly expr

expr: Record<string, unknown>

Protected Readonly filter

filter: Filter<Document<T>>

Protected Readonly path

path: string

Accessors

length

get length(): Length<T>

- Defined in query/String.ts:23
The string length filter

Returns Length<T>

Methods

compare

compare(operator: "$eq" | "$ne", str: string): Match<T>

- Defined in query/String.ts:61
Filter if the comparison returns true

Parameters
- operator: "$eq" | "$ne"
- str: string
Returns Match<T>

equal

equal(str: string): Match<T>

- Defined in query/String.ts:28
Filter if string is equal

Parameters
- str: string
Returns Match<T>

match

match(regex: RegExp): Match<T>

- Defined in query/String.ts:38
Filter if string match with the regex

Parameters
- regex: RegExp
Returns Match<T>

notEqual

notEqual(str: string): Match<T>

- Defined in query/String.ts:33
Filter if string is not equal

Parameters
- str: string
Returns Match<T>

Generated using TypeDoc