Directus / @directus/sdk / rest / readItem

Function: readItem() ​

readItem<Schema, Collection, TQuery>(collection, key, query?): RestCommand<IfAny<Schema, Record<string, any>, Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, any, Collection extends keyof Schema ? UnpackList<...[...]> extends object ? object & UnpackList<...> : never : never>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, any, Collection extends keyof Schema ? UnpackList<...[...]> extends object ? object & UnpackList<...> : never : never>>, FieldsWildcard<UnpackList<IfAny<Schema, any, Collection extends keyof Schema ? UnpackList<...> extends object ? ... & ... : never : never>>, Exclude<UnpackList<Mutable<TQuery["fields"]>>, PickRelationalFields<UnpackList<Mutable<...>>> extends never ? never : AllKeys<UnpackList<...> extends Field ? ... extends ... ? ... : ... : never>>>, FF extends Record<string, string> ? 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, Collection extends keyof (...) ? (...) extends (...) ? (...) : (...) : never>> ? Extract<UnpackList<IfAny<(...), (...), (...)>>[Field], ItemType<Schema>> extends RelatedCollection ? IsNullable<UnpackList<IfAny<(...), (...), (...)>>[Field], null | (RelatedCollection extends (...)[] ? (...) extends (...) ? (...) : (...) : ApplyNestedQueryFields<(...), (...), (...)>), RelatedCollection extends any[] ? HasManyToAnyRelation<(...)> extends never ? (...) | (...) : (...)[] : ApplyNestedQueryFields<Schema, RelatedCollection, (...)[(...)]>> : never : never }>>, Schema>

Get an item that exists in Directus.

Type parameters ​

• Schema extends object

• Collection extends string | number | symbol

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

Parameters ​

• collection: Collection

The collection of the item

• key: string | number

The primary key of the item

• 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 ? object & UnpackList<...> : never : never>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, any, Collection extends keyof Schema ? UnpackList<...[...]> extends object ? object & UnpackList<...> : never : never>>, FieldsWildcard<UnpackList<IfAny<Schema, any, Collection extends keyof Schema ? UnpackList<...> extends object ? ... & ... : never : never>>, Exclude<UnpackList<Mutable<TQuery["fields"]>>, PickRelationalFields<UnpackList<Mutable<...>>> extends never ? never : AllKeys<UnpackList<...> extends Field ? ... extends ... ? ... : ... : never>>>, FF extends Record<string, string> ? 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, Collection extends keyof (...) ? (...) extends (...) ? (...) : (...) : never>> ? Extract<UnpackList<IfAny<(...), (...), (...)>>[Field], ItemType<Schema>> extends RelatedCollection ? IsNullable<UnpackList<IfAny<(...), (...), (...)>>[Field], null | (RelatedCollection extends (...)[] ? (...) extends (...) ? (...) : (...) : ApplyNestedQueryFields<(...), (...), (...)>), RelatedCollection extends any[] ? HasManyToAnyRelation<(...)> extends never ? (...) | (...) : (...)[] : ApplyNestedQueryFields<Schema, RelatedCollection, (...)[(...)]>> : never : never }>>, Schema>

Returns an item object if a valid primary key was provided.

Throws ​

Will throw if collection is a core collection

Throws ​

Will throw if collection is empty

Throws ​

Will throw if key is empty

Source ​

rest/commands/read/items.ts:54