Class ArbitraryFilter<T, TData>

Arbitrary filter for data

Type parameters

T: Types
TData: Types

Hierarchy

ArbitraryFilter

Index

Constructors

constructor

Properties

Accessors

nullish

Methods

Constructors

constructor

new ArbitraryFilter<T, TData>(str: IncrementalString, path: string, filter: Filter<Document<T>>, expr: Record<string, unknown>): ArbitraryFilter<T, TData>

- Defined in query/Filter.ts:41
Type parameters
- T: unknown
- TData: unknown
Parameters
- str: IncrementalString
- path: string
- filter: Filter<Document<T>>
- expr: Record<string, unknown>
Returns ArbitraryFilter<T, TData>

Properties

Protected Readonly expr

expr: Record<string, unknown>

Protected Readonly filter

filter: Filter<Document<T>>

Protected Readonly path

path: string

Protected Readonly str

str: IncrementalString

Accessors

nullish

get nullish(): Match<T>

- Defined in query/Filter.ts:54
Filter if the data is nullish

Returns Match<T>

Methods

array

array(): Array extends DataTypeOf<TData> ? TData extends unknown[] ? ArrayFilter<T, TData> : ArrayFilter<T, unknown[]> : never

- Defined in query/Filter.ts:150
Filter of array type

Returns Array extends DataTypeOf<TData> ? TData extends unknown[] ? ArrayFilter<T, TData> : ArrayFilter<T, unknown[]> : never

bigint

bigint(): BigInt extends DataTypeOf<TData> ? BigFilter<T> : never

- Defined in query/Filter.ts:97
Filter of bigint type

Returns BigInt extends DataTypeOf<TData> ? BigFilter<T> : never

bool

bool(): Bool extends DataTypeOf<TData> ? BoolFilter<T> : never

- Defined in query/Filter.ts:75
Filter of boolean type

Returns Bool extends DataTypeOf<TData> ? BoolFilter<T> : never

byteLength

byteLength(): Bytes extends DataTypeOf<TData> ? Length<T> : never

- Defined in query/Filter.ts:141
Filter of binary data length

Returns Bytes extends DataTypeOf<TData> ? Length<T> : never

clone

clone(): ArbitraryFilter<T, TData>

- Defined in query/Filter.ts:261
Clone the arbitrary filter

Returns ArbitraryFilter<T, TData>

date

date(): Date extends DataTypeOf<TData> ? DateFilter<T> : never

- Defined in query/Filter.ts:119
Filter of date type

Returns Date extends DataTypeOf<TData> ? DateFilter<T> : never

Protected deepClone

deepClone(expr: Record<string, unknown>, obj: object): object

- Defined in query/Filter.ts:313
Deep clone object

Parameters
- expr: Record<string, unknown>
- obj: object
Returns object

mapGet

mapGet(key: string): Map extends DataTypeOf<TData> ? TData extends Map<string, V> ? ArbitraryFilter<T, V> : ArbitraryFilter<T, unknown> : never

- Defined in query/Filter.ts:168
Filter of map value type

Parameters
- key: string
Returns Map extends DataTypeOf<TData> ? TData extends Map<string, V> ? ArbitraryFilter<T, V> : ArbitraryFilter<T, unknown> : never

number

number(): Number extends DataTypeOf<TData> ? NumFilter<T> : never

- Defined in query/Filter.ts:86
Filter of number type

Returns Number extends DataTypeOf<TData> ? NumFilter<T> : never

objGet

objGet<K>(key: K): Object extends DataTypeOf<TData> ? ArbitraryFilter<T, TData[K]> : never

- Defined in query/Filter.ts:190
Filter of object property type

Type parameters
- K: string | number | symbol
Parameters
- key: K
Returns Object extends DataTypeOf<TData> ? ArbitraryFilter<T, TData[K]> : never

regexp

regexp(): RegExp extends DataTypeOf<TData> ? RegexFilter<T> : never

- Defined in query/Filter.ts:130
Filter of regexp type

Returns RegExp extends DataTypeOf<TData> ? RegexFilter<T> : never

Protected resolveReference

resolveReference(expr: Record<string, unknown>, type: DataTypes): string

- Defined in query/Filter.ts:280
Resolve reference and ensure the type

Parameters
- expr: Record<string, unknown>
- type: DataTypes
Returns string

Protected resolveValue

resolveValue(expr: Record<string, unknown>, type: DataTypes): void

- Defined in query/Filter.ts:269
Resolve value and ensure the type

Parameters
- expr: Record<string, unknown>
- type: DataTypes
Returns void

set

set(): Set extends DataTypeOf<TData> ? TData extends Set<E> ? ArrayFilter<T, E[]> : ArrayFilter<T, unknown[]> : never

- Defined in query/Filter.ts:159
Filter of set type

Returns Set extends DataTypeOf<TData> ? TData extends Set<E> ? ArrayFilter<T, E[]> : ArrayFilter<T, unknown[]> : never

string

string(): String extends DataTypeOf<TData> ? StrFilter<T> : never

- Defined in query/Filter.ts:108
Filter of string type

Returns String extends DataTypeOf<TData> ? StrFilter<T> : never

typeOf

typeOf(type: DataTypes, resolveRef?: boolean): Match<T>

- Defined in query/Filter.ts:212
Filter if data type is equal

Parameters
- type: DataTypes
- resolveRef: boolean = false
Returns Match<T>

Generated using TypeDoc