nestjs-temporal-core
    Preparing search index...

    Interface WorkflowUpdateHandle<Ret>

    A client-side handle to an Update.

    interface WorkflowUpdateHandle<Ret> {
        updateId: string;
        workflowId: string;
        workflowRunId?: string;
        result(): Promise<Ret>;
    }

    Type Parameters

    • Ret
    Index
    updateId workflowId workflowRunId?
    result
    updateId: string

    The ID of this Update request.

    workflowId: string

    The ID of the Workflow being targeted by this Update request.

    workflowRunId?: string

    The ID of the Run of the Workflow being targeted by this Update request.

    • Return the result of the Update.

      Returns Promise<Ret>

      WorkflowUpdateFailedError if ApplicationFailure is thrown in the Update handler.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods