Appearance

On this page

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 extends object

• Item

Properties ​

alias? ​

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

Inherited from ​

Query.alias

Source ​

types/query.ts:19

deep? ​

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

Inherited from ​

Query.deep

Source ​

types/query.ts:18

fields? ​

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

Inherited from ​

Query.fields

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>>>>>

Inherited from ​

Query.filter

Source ​

types/query.ts:12

limit? ​

optional limit: number

Inherited from ​

Query.limit

Source ​

types/query.ts:15

offset? ​

optional offset: number

Inherited from ​

Query.offset

Source ​

types/query.ts:16

page? ​

optional page: number

Inherited from ​

Query.page

Source ​

types/query.ts:17

optional search: string

Inherited from ​

Query.search

Source ​

types/query.ts:13

sort? ​

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

Inherited from ​

Query.sort

Source ​

types/query.ts:14

version? ​

optional readonly version: string

Source ​

types/query.ts:26

versionRaw? ​

optional readonly versionRaw: boolean

Source ​

types/query.ts:27