Directus / @directus/sdk / rest / readFolder

Function: readFolder() ​

readFolder<Schema, TQuery>(key, query?): RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, { id: string; name: string; parent: (...) | (...) | (...) }, "directus_folders" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { id: ...; name: ...; parent: ... }>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, { id: string; name: string; parent: (...) | (...) | (...) }, "directus_folders" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { id: ...; name: ...; parent: ... }>>, FieldsWildcard<UnpackList<IfAny<Schema, { id: ...; name: ...; parent: ... }, (...) 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>

Defined in: rest/commands/read/folders.ts:35

List an existing folder by primary key.

Type Parameters ​

• Schema

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

Parameters ​

key ​

DirectusFolder<Schema>["id"]

The primary key of the dashboard

query? ​

TQuery

The query parameters

Returns ​

RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, { id: string; name: string; parent: (...) | (...) | (...) }, "directus_folders" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { id: ...; name: ...; parent: ... }>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, { id: string; name: string; parent: (...) | (...) | (...) }, "directus_folders" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { id: ...; name: ...; parent: ... }>>, FieldsWildcard<UnpackList<IfAny<Schema, { id: ...; name: ...; parent: ... }, (...) 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>

Returns a folder object if a valid primary key was provided.

Throws ​

Will throw if key is empty