Interface ClientWorkflow

interface ClientWorkflow {
    getHandle(taskQueue: string, workflowName: string, workflowId: string, namespace?: string): Promise<WorkflowHandleService>;
    hook(options: HookOptions): Promise<string>;
    search(taskQueue: string, workflowName: string, namespace: string, index: string, ...query: string[]): Promise<string[]>;
    signal(signalId: string, data: StringAnyType, namespace?: string): Promise<string>;
    start(options: WorkflowOptions): Promise<WorkflowHandleService>;
}

Methods

getHandle hook search signal start

Methods

getHandle

hook

search

  • search(taskQueue, workflowName, namespace, index, ...query): Promise<string[]>

  • Parameters

    • taskQueue: string
    • workflowName: string
    • namespace: string
    • index: string
    • Rest...query: string[]

    Returns Promise<string[]>

signal

  • signal(signalId, data, namespace?): Promise<string>

  • Parameters

    Returns Promise<string>

start

Settings

Member Visibility

On This Page

Methods