Appearance

On this page

Directus Cloud

Everything you need to start building. Provisioned in 90 seconds. Starting at $15/month.

Get Started

This is an auto-generated document to support extension builders understand the internal packages they can utilize. To find our written guides, tutorials, and API/SDK reference, check out our main docs .

Directus / @directus/sdk / types / Query

Interface: Query<Schema, Item> ​

Defined in: types/query.ts:10

All query options available

Extended by ​

Type Parameters ​

• Schema

• Item

Properties ​

alias? ​

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

Defined in: types/query.ts:19

deep? ​

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

Defined in: types/query.ts:18

fields? ​

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

Defined in: types/query.ts:11

filter? ​

optional filter: IfAny<Schema, Record<string, any>, QueryFilter<Schema, Item>>

Defined in: types/query.ts:12

limit? ​

optional limit: number

Defined in: types/query.ts:15

offset? ​

optional offset: number

Defined in: types/query.ts:16

page? ​

optional page: number

Defined in: types/query.ts:17

optional search: string

Defined in: types/query.ts:13

sort? ​

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

Defined in: types/query.ts:14