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

@@ -168,7 +168,11 @@ export class WorkflowError extends HarnessError {
}
}
/** Whether combinators must re-throw `error` instead of mapping the item to `null`. */
/**
* Whether combinators must re-throw `error` instead of mapping the item to `null`.
* @param error - any thrown value; fatality is host `instanceof` (unforgeable from a script realm).
* @returns true iff `error` is a {@link WorkflowError} whose `fatal` flag is set.
*/
export function isFatalWorkflowError(error: unknown): boolean {
return error instanceof WorkflowError && error.fatal
}