Workflow Docs
AI/LLM: This documentation page is available in plain markdown format at/workflow/latest/docs/reference/functions/succeed.md
succeed
Function: succeed()#
ts
function succeed<T>(data): object & T;Defined in: packages/workflow-core/src/result.ts:9
Tagged result helpers for workflows that return discriminated success/failure unions. Avoids as const casts at every return site.
return succeed({ output: final }) // { ok: true; output: Draft } return fail(validation: ${reason}) // { ok: false; reason: string }
Type Parameters#
T#
T extends Record<string, unknown>
Parameters#
data#
T
Returns#
object & T