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:
@@ -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
|
||||
}
|
||||
|
||||
@@ -12,7 +12,11 @@ import type { Agent, AgentId } from '@deepseek-ai/dsh-agent'
|
||||
/** Identifies one workflow run. */
|
||||
export type WorkflowRunId = Branded<'WorkflowRunId'>
|
||||
|
||||
/** Brand a string as a {@link WorkflowRunId}. */
|
||||
/**
|
||||
* Brand a string as a {@link WorkflowRunId}.
|
||||
* @param id - the raw id string (the engine mints UUIDs; tests may pass fixtures).
|
||||
* @returns the same string, branded.
|
||||
*/
|
||||
export function WorkflowRunId(id: string): WorkflowRunId {
|
||||
return id as WorkflowRunId
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user