Directus / @directus/sdk / types / QueryItem

Interface: QueryItem<Schema, Item> ​

Defined in: types/query.ts:25

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

Extends ​

• Query<Schema, Item>

Type Parameters ​

• Schema

• Item

Properties ​

alias? ​

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

Defined in: types/query.ts:19

Inherited from ​

Query.alias

deep? ​

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

Defined in: types/query.ts:18

Inherited from ​

Query.deep

fields? ​

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

Defined in: types/query.ts:11

Inherited from ​

Query.fields

filter? ​

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

Defined in: types/query.ts:12

Inherited from ​

Query.filter

limit? ​

optional limit: number

Defined in: types/query.ts:15

Inherited from ​

Query.limit

offset? ​

optional offset: number

Defined in: types/query.ts:16

Inherited from ​

Query.offset

page? ​

optional page: number

Defined in: types/query.ts:17

Inherited from ​

Query.page

search? ​

optional search: string

Defined in: types/query.ts:13

Inherited from ​

Query.search

sort? ​

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

Defined in: types/query.ts:14

Inherited from ​

Query.sort

version? ​

readonly optional version: string

Defined in: types/query.ts:26

versionRaw? ​

readonly optional versionRaw: boolean

Defined in: types/query.ts:27