Directus / @directus/sdk / rest / readComment

Function: readComment() ​

readComment<Schema, TQuery>(key, query?): RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, { collection: (...) | (...); comment: string; date_created: (...) | (...); date_updated: (...) | (...); id: string; item: string; user_created: (...) | (...) | (...); user_updated: (...) | (...) | (...) }, "directus_comments" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { collection: ...; comment: ...; date_created: ...; date_updated: ...; id: ...; item: ...; user_created: ...; user_updated: ... }>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, { collection: (...) | (...); comment: string; date_created: (...) | (...); date_updated: (...) | (...); id: string; item: string; user_created: (...) | (...) | (...); user_updated: (...) | (...) | (...) }, "directus_comments" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { collection: ...; comment: ...; date_created: ...; date_updated: ...; id: ...; item: ...; user_created: ...; user_updated: ... }>>, FieldsWildcard<UnpackList<IfAny<Schema, { collection: ...; comment: ...; date_created: ...; date_updated: ...; id: ...; item: ...; user_created: ...; user_updated: ... }, (...) 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/comments.ts:35

List an existing comment by primary key.

Type Parameters ​

• Schema

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

Parameters ​

key ​

DirectusComment<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, { collection: (...) | (...); comment: string; date_created: (...) | (...); date_updated: (...) | (...); id: string; item: string; user_created: (...) | (...) | (...); user_updated: (...) | (...) | (...) }, "directus_comments" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { collection: ...; comment: ...; date_created: ...; date_updated: ...; id: ...; item: ...; user_created: ...; user_updated: ... }>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, { collection: (...) | (...); comment: string; date_created: (...) | (...); date_updated: (...) | (...); id: string; item: string; user_created: (...) | (...) | (...); user_updated: (...) | (...) | (...) }, "directus_comments" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { collection: ...; comment: ...; date_created: ...; date_updated: ...; id: ...; item: ...; user_created: ...; user_updated: ... }>>, FieldsWildcard<UnpackList<IfAny<Schema, { collection: ...; comment: ...; date_created: ...; date_updated: ...; id: ...; item: ...; user_created: ...; user_updated: ... }, (...) 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 Comment object if a valid primary key was provided.

Throws ​

Will throw if key is empty