Directus / @directus/sdk / rest / readSingleton
Function: readSingleton() ​
readSingleton<
Schema,Collection,TQuery>(collection,query?):RestCommand<IfAny<Schema,Record<string,any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, any, Collection extends keyof (...) ? (...) extends (...) ? (...) : (...) : never>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, any, Collection extends keyof (...) ? (...) extends (...) ? (...) : (...) : never>>, FieldsWildcard<UnpackList<IfAny<Schema, any, (...) extends (...) ? (...) : (...)>>, Exclude<UnpackList<Mutable<(...)>>, PickRelationalFields<(...)> extends never ? never : AllKeys<(...)>>>, 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<(...), (...), (...)>> ? Extract<(...)[(...)], ItemType<(...)>> extends RelatedCollection ? IsNullable<(...)[(...)], (...) | (...), (...) extends (...) ? (...) : (...)> : never : never }>[K] }>,Schema>
List the singleton item in Directus.
Type Parameters ​
• Schema
• Collection extends string | number | symbol
• TQuery extends QueryItem<Schema, Schema[Collection]>
Parameters ​
• collection: Collection
The collection of the items
• query?: TQuery
The query parameters
Returns ​
RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, any, Collection extends keyof (...) ? (...) extends (...) ? (...) : (...) : never>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, any, Collection extends keyof (...) ? (...) extends (...) ? (...) : (...) : never>>, FieldsWildcard<UnpackList<IfAny<Schema, any, (...) extends (...) ? (...) : (...)>>, Exclude<UnpackList<Mutable<(...)>>, PickRelationalFields<(...)> extends never ? never : AllKeys<(...)>>>, 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<(...), (...), (...)>> ? Extract<(...)[(...)], ItemType<(...)>> extends RelatedCollection ? IsNullable<(...)[(...)], (...) | (...), (...) extends (...) ? (...) : (...)> : never : never }>[K] }>, 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