Directus / @directus/sdk / types / Query

Interface: Query<Schema, Item> ​

All query options available

Extended by ​

• QueryItem

Type parameters ​

• Schema extends object

• Item

Properties ​

alias? ​

optional readonly alias: IfAny<Schema, Record<string, string>, QueryAlias<Schema, Item>>

Source ​

types/query.ts:19

deep? ​

optional deep: IfAny<Schema, Record<string, any>, QueryDeep<Schema, Item>>

Source ​

types/query.ts:18

fields? ​

optional readonly fields: IfAny<Schema, (string | Record<string, any>)[], QueryFields<Schema, Item>>

Source ​

types/query.ts:11

filter? ​

optional filter: IfAny<Schema, Record<string, any>, Partial<Merge<Object, NestedQueryFilter<Schema, Item>, Object, IfNever<NestedQueryFilter<Schema, Item>, unknown, NestedQueryFilter<Schema, Item>>>>>

Source ​

types/query.ts:12

limit? ​

optional limit: number

Source ​

types/query.ts:15

offset? ​

optional offset: number

Source ​

types/query.ts:16

page? ​

optional page: number

Source ​

types/query.ts:17

search? ​

optional search: string

Source ​

types/query.ts:13

sort? ​

optional sort: IfAny<Schema, string | string[], QuerySort<Schema, Item> | QuerySort<Schema, Item>[]>

Source ​

types/query.ts:14