Directus / @directus/sdk / rest / readItems

Function: readItems() ​

readItems<Schema, Collection, TQuery>(collection, query?): RestCommand<IfAny<Schema, Record<string, any>, Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, any, Collection extends keyof Schema ? UnpackList<...> extends object ? ... & ... : never : never>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, any, Collection extends keyof Schema ? UnpackList<...> extends object ? ... & ... : never : never>>, FieldsWildcard<UnpackList<IfAny<Schema, any, Collection extends keyof ... ? ... extends ... ? ... : ... : never>>, Exclude<UnpackList<Mutable<...[...]>>, PickRelationalFields<UnpackList<...>> extends never ? never : AllKeys<... extends ... ? ... : ...>>>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof UnpackList<IfAny<Schema, any, (...) extends (...) ? (...) : (...)>> ? Extract<UnpackList<(...)>[Field<(...)>], ItemType<Schema>> extends RelatedCollection ? IsNullable<UnpackList<(...)>[Field<(...)>], null | ((...) extends (...) ? (...) : (...)), RelatedCollection extends (...)[] ? (...) extends (...) ? (...) : (...) : ApplyNestedQueryFields<(...), (...), (...)>> : never : never }>>[], Schema>

List all items that exist in Directus.

Type parameters ​

• Schema

• Collection extends string | number | symbol

• TQuery extends Query<Schema, CollectionType<Schema, Collection>>

Parameters ​

• collection: Collection

The collection of the items

• query?: TQuery

The query parameters

Returns ​

RestCommand<IfAny<Schema, Record<string, any>, Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, any, Collection extends keyof Schema ? UnpackList<...> extends object ? ... & ... : never : never>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, any, Collection extends keyof Schema ? UnpackList<...> extends object ? ... & ... : never : never>>, FieldsWildcard<UnpackList<IfAny<Schema, any, Collection extends keyof ... ? ... extends ... ? ... : ... : never>>, Exclude<UnpackList<Mutable<...[...]>>, PickRelationalFields<UnpackList<...>> extends never ? never : AllKeys<... extends ... ? ... : ...>>>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof UnpackList<IfAny<Schema, any, (...) extends (...) ? (...) : (...)>> ? Extract<UnpackList<(...)>[Field<(...)>], ItemType<Schema>> extends RelatedCollection ? IsNullable<UnpackList<(...)>[Field<(...)>], null | ((...) extends (...) ? (...) : (...)), RelatedCollection extends (...)[] ? (...) extends (...) ? (...) : (...) : ApplyNestedQueryFields<(...), (...), (...)>> : never : never }>>[], Schema>

An array of up to limit item objects. If no items are available, data will be an empty array.

Throws ​

Will throw if collection is a core collection

Throws ​

Will throw if collection is empty

Source ​

rest/commands/read/items.ts:22