Interface WorkflowInstance<Params>

Workflow instance returned by create() or get()

interface WorkflowInstance<Params = unknown> {
    id: string;
    pause(): Promise<void>;
    restart(): Promise<void>;
    resume(): Promise<void>;
    status(): Promise<WorkflowInstanceStatus>;
    terminate(): Promise<void>;
}

Type Parameters

Params = unknown

Index

Properties

Methods

pause restart resume status terminate

Properties

id

id: string

Methods

pause

pause(): Promise<void>
Returns Promise<void>
- Defined in workflow.ts:100

restart

restart(): Promise<void>
Returns Promise<void>
- Defined in workflow.ts:103

resume

resume(): Promise<void>
Returns Promise<void>
- Defined in workflow.ts:101

status

status(): Promise<WorkflowInstanceStatus>
Returns Promise<WorkflowInstanceStatus>
- Defined in workflow.ts:104

terminate

terminate(): Promise<void>
Returns Promise<void>
- Defined in workflow.ts:102