Class NumFilter<T>

A filter which work with numbers

Type parameters

T: Types

Hierarchy

NumFilter

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

- Defined in query/Number.ts:11
Type parameters
- T: unknown
Parameters
- path: string
- filter: Filter<Document<T>>
- expr: Record<string, unknown>
Returns NumFilter<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" | "$gt" | "$gte" | "$lt" | "$lte", num: number): Match<T>

- Defined in query/Number.ts:52
Filter if the comparison return true

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

equal

equal(num: number): Match<T>

- Defined in query/Number.ts:22
Filter if number is equal

Parameters
- num: number
Returns Match<T>

greaterThan

greaterThan(num: number): Match<T>

- Defined in query/Number.ts:32
Filter if number is greater than

Parameters
- num: number
Returns Match<T>

greaterThanEqual

greaterThanEqual(num: number): Match<T>

- Defined in query/Number.ts:37
Filter if number is greater than or equal

Parameters
- num: number
Returns Match<T>

lessThan

lessThan(num: number): Match<T>

- Defined in query/Number.ts:42
Filter if number is less than

Parameters
- num: number
Returns Match<T>

lessThanEqual

lessThanEqual(num: number): Match<T>

- Defined in query/Number.ts:47
Filter if number is less than or equal

Parameters
- num: number
Returns Match<T>

notEqual

notEqual(num: number): Match<T>

- Defined in query/Number.ts:27
Filter if number is not equal

Parameters
- num: number
Returns Match<T>

Generated using TypeDoc