docs(plugins): the hook result comment names metadata as the field that stays

This commit is contained in:
Mohamed Boudra
2026-11-02 05:09:28 +01:00
parent 7a651fceb3
commit 77f90d3460
+1 -1
View File
@@ -132,7 +132,7 @@ export interface PluginHookRequests {
"workspace.create.before": Omit<WorkspaceCreateRequest, "type" | "requestId">;
}
/** What a hook may return: a field it leaves out stays as it was. */
/** What a hook may return. An omitted `metadata` stays as it was. */
type PluginHookRequestResults = Omit<PluginHookRequests, "agent.open.before"> & {
"agent.open.before": Omit<PluginSessionOpenRequest, "metadata"> & {
metadata?: Readonly<Record<string, JsonValue>>;