Class WorkflowProxy<T>

Concrete implementation of IWorkflowProxy<T>.

Plain class — not @Injectable. Instances are created by WorkflowProxyFactory and registered as NestJS providers via createWorkflowProvider().

Type Parameters

T extends Workflow

Implements

IWorkflowProxy<T>

Index

Constructors

constructor

Methods

getHandle query queryByName signal signalByName signalWithStart start

Constructors

constructor

new WorkflowProxy<T extends Workflow>(
clientService: TemporalClientService,
config: WorkflowProxyConfig,
): WorkflowProxy<T>
Type Parameters
- T extends Workflow
Parameters
- clientService: TemporalClientService
- config: WorkflowProxyConfig
Returns WorkflowProxy<T>
- Defined in src/workflow-proxy/workflow-proxy.ts:163

Methods

getHandle

getHandle(workflowId: string, runId?: string): Promise<WorkflowHandle<T>>
Get a typed handle to an existing workflow execution. result() on the handle returns Promise<WorkflowResultType<T>>.
Parameters
- workflowId: string
- OptionalrunId: string
Returns Promise<WorkflowHandle<T>>
Example
```
const handle = await this.orderProxy.getHandle('order-42');
const result = await handle.result(); // typed as the workflow's return type
```
Implementation of IWorkflowProxy.getHandle
- Defined in src/workflow-proxy/workflow-proxy.ts:180

query

query<TResult, TArgs extends unknown[] = []>(
    workflowId: string,
    queryDef: QueryDefinition<TResult, TArgs>,
    ...args: TArgs,
): Promise<TResult>
Query the workflow using a typed QueryDefinition created with defineQuery. TResult and TArgs are both inferred from the definition.
Type Parameters
- TResult
- TArgs extends unknown[] = []
Parameters
- workflowId: string
- queryDef: QueryDefinition<TResult, TArgs>
- ...args: TArgs
Returns Promise<TResult>
Example
```
// in workflow file: export const statusQuery = defineQuery<OrderStatus>('getStatus');
const status = await this.orderProxy.query('order-42', statusQuery); // typed: OrderStatus

// query with args:
// export const itemQuery = defineQuery<Item, [string]>('getItem');
const item = await this.orderProxy.query('order-42', itemQuery, 'item-id');
```
Implementation of IWorkflowProxy.query
- Defined in src/workflow-proxy/workflow-proxy.ts:201

queryByName

queryByName<TResult>(
    workflowId: string,
    queryName: string,
    args?: readonly unknown[],
): Promise<TResult>
Query by string name. Use when a QueryDefinition is unavailable. Caller must supply TResult explicitly (e.g. queryByName<OrderStatus>(...)).
Type Parameters
- TResult
Parameters
- workflowId: string
- queryName: string
- Optionalargs: readonly unknown[]
Returns Promise<TResult>
Example
```
const status = await this.orderProxy.queryByName<OrderStatus>(
  'order-42',
  'getStatus',
);
```
Implementation of IWorkflowProxy.queryByName
- Defined in src/workflow-proxy/workflow-proxy.ts:209

signal

signal<TArgs extends unknown[]>(
    workflowId: string,
    signalDef: SignalDefinition<TArgs>,
    ...args: TArgs,
): Promise<void>
Send a typed signal using a SignalDefinition created with defineSignal. TypeScript infers TArgs from the definition — call site is fully type-checked.
Type Parameters
- TArgs extends unknown[]
Parameters
- workflowId: string
- signalDef: SignalDefinition<TArgs>
- ...args: TArgs
Returns Promise<void>
Example
```
// in workflow file: export const approveSignal = defineSignal<[string]>('approve');
await this.orderProxy.signal('order-42', approveSignal, 'manager-approval');
```
Implementation of IWorkflowProxy.signal
- Defined in src/workflow-proxy/workflow-proxy.ts:185

signalByName

signalByName(
    workflowId: string,
    signalName: string,
    args?: readonly unknown[],
): Promise<void>
Send a signal by string name. Use when a SignalDefinition is unavailable. Args are readonly unknown[] — no implicit any.
Parameters
- workflowId: string
- signalName: string
- Optionalargs: readonly unknown[]
Returns Promise<void>
Example
```
await this.orderProxy.signalByName('order-42', 'approve', ['manager-approval']);
```
Implementation of IWorkflowProxy.signalByName
- Defined in src/workflow-proxy/workflow-proxy.ts:193

signalWithStart

signalWithStart<TSignalArgs extends unknown[]>(
    signalDef: SignalDefinition<TSignalArgs>,
    signalArgs: TSignalArgs,
    workflowArgs: Parameters<T>,
    options?: WorkflowStartOptions,
): Promise<WorkflowHandleWithMetadata<T>>
Atomically start the workflow and send a signal. If the workflow is already running, only the signal is delivered (no duplicate start). Both signalArgs and workflowArgs are fully typed via the respective definitions.
Type Parameters
- TSignalArgs extends unknown[]
Parameters
- signalDef: SignalDefinition<TSignalArgs>
- signalArgs: TSignalArgs
- workflowArgs: Parameters<T>
- Optionaloptions: WorkflowStartOptions
Returns Promise<WorkflowHandleWithMetadata<T>>
Example: Idempotent "ensure running + signal"
```
// export const addItemSignal = defineSignal<[CartItem]>('addItem');
await this.cartProxy.signalWithStart(
  addItemSignal,
  [{ sku: 'SKU-123', qty: 2 }],   // signalArgs — typed
  [userId],                        // workflowArgs — typed as Parameters<cartWorkflow>
  { workflowId: `cart-${userId}`, taskQueue: 'carts' },
);
```
Implementation of IWorkflowProxy.signalWithStart
- Defined in src/workflow-proxy/workflow-proxy.ts:217

start

start(
args: Parameters<T>,
options?: WorkflowStartOptions,
): Promise<WorkflowHandleWithMetadata<T>>
Start a new execution of this workflow. Args are typed as Parameters<T> — TypeScript enforces the workflow's signature.
Parameters
- args: Parameters<T>
- Optionaloptions: WorkflowStartOptions
Returns Promise<WorkflowHandleWithMetadata<T>>
Example
```
// orderWorkflow: (orderId: string, customerId: number) => Promise<{ status: string }>
const handle = await this.orderProxy.start(
  ['order-42', 7],
  { workflowId: 'order-42', workflowIdReusePolicy: 'ALLOW_DUPLICATE' },
);
const { status } = await handle.result(); // typed: { status: string }
```
Implementation of IWorkflowProxy.start
- Defined in src/workflow-proxy/workflow-proxy.ts:168

Class WorkflowProxy<T>

Type Parameters

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns WorkflowProxy<T>

Methods

getHandle

Parameters

Returns Promise<WorkflowHandle<T>>

Example

query

Type Parameters

Parameters

Returns Promise<TResult>

Example

queryByName

Type Parameters

Parameters

Returns Promise<TResult>

Example

signal

Type Parameters

Parameters

Returns Promise<void>

Example

signalByName

Parameters

Returns Promise<void>

Example

signalWithStart

Type Parameters

Parameters

Returns Promise<WorkflowHandleWithMetadata<T>>

Example: Idempotent "ensure running + signal"

start

Parameters

Returns Promise<WorkflowHandleWithMetadata<T>>

Example

Settings

On This Page