Skip to content
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 / QueryItem

Interface: QueryItem<Schema, Item> ​

All query options with an additional version query option for readItem and readSingleton

Extends ​

Type Parameters ​

• Schema

• Item

Properties ​

alias? ​

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

Inherited from ​

Query.alias

Defined in ​

types/query.ts:19


deep? ​

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

Inherited from ​

Query.deep

Defined in ​

types/query.ts:18


fields? ​

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

Inherited from ​

Query.fields

Defined in ​

types/query.ts:11


filter? ​

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

Inherited from ​

Query.filter

Defined in ​

types/query.ts:12


limit? ​

optional limit: number

Inherited from ​

Query.limit

Defined in ​

types/query.ts:15


offset? ​

optional offset: number

Inherited from ​

Query.offset

Defined in ​

types/query.ts:16


page? ​

optional page: number

Inherited from ​

Query.page

Defined in ​

types/query.ts:17


optional search: string

Inherited from ​

Query.search

Defined in ​

types/query.ts:13


sort? ​

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

Inherited from ​

Query.sort

Defined in ​

types/query.ts:14


version? ​

readonly optional version: string

Defined in ​

types/query.ts:26


versionRaw? ​

readonly optional versionRaw: boolean

Defined in ​

types/query.ts:27