WorkflowControls
Interface: WorkflowControls
Defined in: packages/workflow/src/hooks.ts:4
The controls of the workflow engine, called by the WorkflowInstance actions
Methods
cancelInstance()
cancelInstance(
uuid):Promise<void>
Defined in: packages/workflow/src/hooks.ts:9
Cancel an instance, its live tasks and its awaited children
Parameters
uuid
string
the instance uuid
Returns
Promise<void>
getStoredWorkflowRole()
getStoredWorkflowRole():
string
Defined in: packages/workflow/src/hooks.ts:25
Role needed to write a stored workflow
Returns
string
the role
migrateInstance()
migrateInstance(
uuid,version?):Promise<void>
Defined in: packages/workflow/src/hooks.ts:20
Move an instance to another version of its flow
Parameters
uuid
string
the instance uuid
version?
string
the target version, the latest registered when undefined
Returns
Promise<void>
retryInstance()
retryInstance(
uuid):Promise<void>
Defined in: packages/workflow/src/hooks.ts:14
Restart a failed instance from its failed task
Parameters
uuid
string
the instance uuid
Returns
Promise<void>