docs: satisfy the export-JSDoc gate across the workflow packages

Master's verify-export-jsdoc landed mid-stack; complete the six missing
@param/@returns on the workflow trio's public surface (and the services
catalog they regenerate into).
This commit is contained in:
Tianyi Cui
2026-07-07 22:39:05 +08:00
parent 8db99d36e8
commit 1f5db6e0b0
4 changed files with 15 additions and 3 deletions

View File

@@ -225,6 +225,8 @@ export class WorkflowExecution {
* `disposeGraceMs` (parked on a promise no hook owns) is abandoned so
* `result` settles regardless (see {@link abandoned}). Idempotent; the
* first reason wins.
* @param reason - human-readable cause, carried on the CANCELLED error and
* into child `run.cancel()` calls (default `'workflow cancelled'`).
*/
cancel(reason?: string): void {
if (this.cancelReason !== undefined) return
@@ -244,6 +246,8 @@ export class WorkflowExecution {
* cancellation (or outlived its post-cancel grace and was abandoned — see
* {@link abandoned}). After settlement, any stray children a script fired
* without awaiting are aborted (their `agent()` wrappers dispose them).
* @returns the settled outcome — this promise NEVER rejects (the seam's
* `result`-never-rejects contract); every failure maps to a variant.
*/
async drive(): Promise<WorkflowResult> {
try {