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 / rest / readCollection

Function: readCollection() ​

readCollection<Schema>(collection): RestCommand<IfAny<Schema, Record<string, any>, Merge<MappedFunctionFields<Schema, DirectusCollection<Schema>> extends FF ? MapFlatFields<DirectusCollection<Schema>, keyof DirectusCollection<Schema>, FF extends Record<string, string> ? FF : Record<string, string>> : never, Object>>, Schema>

Retrieve a single collection by table name.

Type parameters ​

• Schema extends object

Parameters ​

• collection: string

The collection name

Returns ​

RestCommand<IfAny<Schema, Record<string, any>, Merge<MappedFunctionFields<Schema, DirectusCollection<Schema>> extends FF ? MapFlatFields<DirectusCollection<Schema>, keyof DirectusCollection<Schema>, FF extends Record<string, string> ? FF : Record<string, string>> : never, Object>>, Schema>

A collection object.

Throws ​

Will throw if collection is empty

Source ​

rest/commands/read/collections.ts:29