nestjs-temporal-core
    Preparing search index...

    Interface WorkflowStartOptions

    Workflow start options aligned with Temporal's official SDK types.

    taskQueue is optional here because the module-level default is applied by TemporalClientService when omitted. All other fields map 1:1 to Temporal's WorkflowStartOptions from @temporalio/client.

    interface WorkflowStartOptions {
        memo?: Record<string, unknown>;
        retryPolicy?: RetryPolicy;
        searchAttributes?: TypedSearchAttributes;
        taskQueue?: string;
        workflowExecutionTimeout?: Duration;
        workflowId?: string;
        workflowIdReusePolicy?: WorkflowIdReusePolicy;
        workflowRunTimeout?: Duration;
        workflowTaskTimeout?: Duration;
    }
    Index

    Properties

    memo? retryPolicy? searchAttributes? taskQueue? workflowExecutionTimeout? workflowId? workflowIdReusePolicy? workflowRunTimeout? workflowTaskTimeout?

    Properties

    memo?: Record<string, unknown>

    Freeform workflow annotations. Temporal accepts Record<string, unknown>.

    retryPolicy?: RetryPolicy

    Retry policy for the workflow execution.

    searchAttributes?: TypedSearchAttributes

    Typed search attributes — maps to typedSearchAttributes in Temporal's SDK.

    taskQueue?: string
    workflowExecutionTimeout?: Duration
    workflowId?: string
    workflowIdReusePolicy?: WorkflowIdReusePolicy

    Use WorkflowIdReusePolicy enum from @temporalio/client.

    workflowRunTimeout?: Duration
    workflowTaskTimeout?: Duration

    Settings

    Member Visibility

    On This Page

    Properties