Directus / @directus/sdk / rest / readPresets

Function: readPresets() ​

readPresets<Schema, TQuery>(query?): RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, { bookmark: ...; collection: ...; color: ...; filter: ...; icon: ...; id: ...; layout: ...; layout_options: ...; layout_query: ...; refresh_interval: ...; role: ...; search: ...; user: ... }, (...) extends (...) ? (...) : (...)>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, { bookmark: ...; collection: ...; color: ...; filter: ...; icon: ...; id: ...; layout: ...; layout_options: ...; layout_query: ...; refresh_interval: ...; role: ...; search: ...; user: ... }, (...) extends (...) ? (...) : (...)>>, FieldsWildcard<UnpackList<IfAny<(...), (...), (...)>>, Exclude<UnpackList<(...)>, (...) extends (...) ? (...) : (...)>>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<(...)[(...)]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof UnpackList<(...)> ? Extract<(...), (...)> extends RelatedCollection ? IsNullable<(...), (...), (...)> : never : never }>[K] }>[], Schema>

Defined in: rest/commands/read/presets.ts:18

List all Presets that exist in Directus.

Type Parameters ​

• Schema

• TQuery extends Query<Schema, DirectusPreset<Schema>>

Parameters ​

query? ​

TQuery

The query parameters

Returns ​

RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, { bookmark: ...; collection: ...; color: ...; filter: ...; icon: ...; id: ...; layout: ...; layout_options: ...; layout_query: ...; refresh_interval: ...; role: ...; search: ...; user: ... }, (...) extends (...) ? (...) : (...)>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, { bookmark: ...; collection: ...; color: ...; filter: ...; icon: ...; id: ...; layout: ...; layout_options: ...; layout_query: ...; refresh_interval: ...; role: ...; search: ...; user: ... }, (...) extends (...) ? (...) : (...)>>, FieldsWildcard<UnpackList<IfAny<(...), (...), (...)>>, Exclude<UnpackList<(...)>, (...) extends (...) ? (...) : (...)>>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<(...)[(...)]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof UnpackList<(...)> ? Extract<(...), (...)> extends RelatedCollection ? IsNullable<(...), (...), (...)> : never : never }>[K] }>[], Schema>

An array of up to limit Preset objects. If no items are available, data will be an empty array.