Class ArrayFilter<T, TData>

A filter which work with arrays

Type parameters

T: Types
TData: unknown[]

Hierarchy

ArrayFilter

Index

Constructors

constructor

Properties

Accessors

length

Methods

Constructors

constructor

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

- Defined in query/Array.ts:14
Type parameters
- T: unknown
- TData: unknown[]
Parameters
- str: IncrementalString
- path: string
- filter: Filter<Document<T>>
- expr: Record<string, unknown>
Returns ArrayFilter<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

length

get length(): Length<T>

- Defined in query/Array.ts:27
The array length filter

Returns Length<T>

Methods

at

at<P>(index: number | P): ArbitraryFilter<T, TData[P]>

- Defined in query/Array.ts:76
Filter for the specific element of array

Type parameters
- P: never
Parameters
- index: number | P
Returns ArbitraryFilter<T, TData[P]>

first

first(): TData extends [E, ...unknown[]] ? ArbitraryFilter<T, E> : TData extends E[] ? ArbitraryFilter<T, E> : never

- Defined in query/Array.ts:32
Filter for the first element of array

Returns TData extends [E, ...unknown[]] ? ArbitraryFilter<T, E> : TData extends E[] ? ArbitraryFilter<T, E> : never

last

last(): TData extends [...unknown[], E] ? ArbitraryFilter<T, E> : TData extends E[] ? ArbitraryFilter<T, E> : never

- Defined in query/Array.ts:54
Filter for the last element of array

Returns TData extends [...unknown[], E] ? ArbitraryFilter<T, E> : TData extends E[] ? ArbitraryFilter<T, E> : never

Generated using TypeDoc