Directus / @directus/sdk / rest / readFieldsByCollection
Function: readFieldsByCollection() ​
readFieldsByCollection<
Schema
>(collection
):RestCommand
<IfAny
<Schema
,Record
<string
,any
>,{ [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, DirectusField<Schema>> extends FF ? MapFlatFields<DirectusField<Schema>, keyof DirectusField<Schema>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, Object>[K] }
>[],Schema
>
List the available fields in a given collection.
Type parameters ​
• Schema
Parameters ​
• collection: string
The primary key of the field
Returns ​
RestCommand
<IfAny
<Schema
, Record
<string
, any
>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, DirectusField<Schema>> extends FF ? MapFlatFields<DirectusField<Schema>, keyof DirectusField<Schema>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, Object>[K] }
>[], Schema
>
Throws ​
Will throw if collection is empty