@temporalio/client/lib/internal.d.ts

Temporal.io SDK Client sub-package

import { temporal } from '@temporalio/proto';
import { WorkflowOptions } from './workflow-options';
/**
 * A symbol used to attach extra, SDK-internal options to the `WorkflowClient.start()` call.
 *
 * These are notably used by the Temporal Nexus helpers.
 *
 * @internal
 * @hidden
 */
export declare const InternalWorkflowStartOptionsSymbol: unique symbol;
export interface InternalWorkflowStartOptions extends WorkflowOptions {
    [InternalWorkflowStartOptionsSymbol]?: {
        /**
         * Request ID to be used for the workflow.
         */
        requestId?: string;
        /**
         * Callbacks to be called by the server when this workflow reaches a terminal state.
         * If the workflow continues-as-new, these callbacks will be carried over to the new execution.
         * Callback addresses must be whitelisted in the server's dynamic configuration.
         */
        completionCallbacks?: temporal.api.common.v1.ICallback[];
        /**
         * Links to be associated with the workflow.
         */
        links?: temporal.api.common.v1.ILink[];
        /**
         * Backlink copied by the client from the StartWorkflowExecutionResponse.
         * Only populated in servers newer than 1.27.
         */
        backLink?: temporal.api.common.v1.ILink;
        /**
         * Conflict options for when USE_EXISTING is specified.
         *
         * Used by the Nexus WorkflowRunOperations to attach to a callback to a running workflow.
         */
        onConflictOptions?: temporal.api.workflow.v1.IOnConflictOptions;
    };
}