Class Length<T>

A filter which work with data length

Type parameters

T: Types

Hierarchy

Length

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

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

Properties

Protected Readonly expr

expr: Record<string, unknown>

Protected Readonly filter

filter: Filter<Document<T>>

Protected Readonly operator

operator: string

Protected Readonly path

path: string

Methods

compare

compare(operator: "$eq" | "$ne" | "$gt" | "$gte" | "$lt" | "$lte", length: number): Match<T>

- Defined in query/Length.ts:55
Filter if the comparison return true

Parameters
- operator: "$eq" | "$ne" | "$gt" | "$gte" | "$lt" | "$lte"
- length: number
Returns Match<T>

equal

equal(length: number): Match<T>

- Defined in query/Length.ts:25
Filter if length is equal

Parameters
- length: number
Returns Match<T>

greaterThan

greaterThan(length: number): Match<T>

- Defined in query/Length.ts:35
Filter if length is greater than

Parameters
- length: number
Returns Match<T>

greaterThanEqual

greaterThanEqual(length: number): Match<T>

- Defined in query/Length.ts:40
Filter if length is greater than or equal

Parameters
- length: number
Returns Match<T>

lessThan

lessThan(length: number): Match<T>

- Defined in query/Length.ts:45
Filter if length is less than

Parameters
- length: number
Returns Match<T>

lessThanEqual

lessThanEqual(length: number): Match<T>

- Defined in query/Length.ts:50
Filter if length is less than or equal

Parameters
- length: number
Returns Match<T>

notEqual

notEqual(length: number): Match<T>

- Defined in query/Length.ts:30
Filter if length is not equal

Parameters
- length: number
Returns Match<T>

Generated using TypeDoc