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 / readFieldsByCollection

Function: readFieldsByCollection() ​

readFieldsByCollection<Schema>(collection): RestCommand<IfAny<Schema, Record<string, any>, Merge<MappedFunctionFields<Schema, DirectusField<Schema>> extends FF ? MapFlatFields<DirectusField<Schema>, keyof DirectusField<Schema>, FF extends Record<string, string> ? FF : Record<string, string>> : never, Object>>[], Schema>

List the available fields in a given collection.

Type parameters ​

• Schema extends object

Parameters ​

• collection: string

The primary key of the field

Returns ​

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

Throws ​

Will throw if collection is empty

Source ​

rest/commands/read/fields.ts:31