Class TemporalClientService

Temporal Client Service

Provides a clean interface for Temporal client operations including:

Workflow execution (start, terminate, cancel)
Signal and query operations
Workflow handle management
Client health monitoring

Example

// Start a workflow
const handle = await clientService.startWorkflow('myWorkflow', { data: 'example' });

// Send a signal
await clientService.signalWorkflow(handle, 'updateData', 'new data');

// Query workflow state
const result = await clientService.queryWorkflow(handle, 'getStatus');

Implements

OnModuleInit

Index

Constructors

constructor

Methods

cancelWorkflow getHealth getRawClient getStatus getWorkflowHandle getWorkflowResult isHealthy onModuleInit queryWorkflow queryWorkflowHandle signalWithStart signalWorkflow signalWorkflowHandle startWorkflow terminateWorkflow

Constructors

constructor

new TemporalClientService(
temporalClient: Client | null,
options: TemporalOptions,
): TemporalClientService
Parameters
- temporalClient: Client | null
- options: TemporalOptions
Returns TemporalClientService
- Defined in src/services/temporal-client.service.ts:47

Methods

cancelWorkflow

cancelWorkflow(workflowId: string, runId?: string): Promise<void>
Cancel a workflow execution
Parameters
- workflowId: string
- OptionalrunId: string
Returns Promise<void>
- Defined in src/services/temporal-client.service.ts:222

getHealth

getHealth(): ClientHealthStatus
Get client health status

Returns ClientHealthStatus
- Defined in src/services/temporal-client.service.ts:456

getRawClient

getRawClient(): Client | null
Get raw Temporal client (use with caution)

Returns Client | null
- Defined in src/services/temporal-client.service.ts:476

getStatus

getStatus(): ClientServiceStatus
Get client status for monitoring

Returns ClientServiceStatus
- Defined in src/services/temporal-client.service.ts:463

getWorkflowHandle

getWorkflowHandle(
workflowId: string,
runId?: string,
): Promise<WorkflowHandle<Workflow>>
Get handle to an existing workflow
Parameters
- workflowId: string
- OptionalrunId: string
Returns Promise<WorkflowHandle<Workflow>>
- Defined in src/services/temporal-client.service.ts:186

getWorkflowResult

getWorkflowResult<T = unknown>(workflowId: string, runId?: string): Promise<T>
Wait for workflow completion and get result
Type Parameters
- T = unknown
Parameters
- workflowId: string
- OptionalrunId: string
Returns Promise<T>
- Defined in src/services/temporal-client.service.ts:417

isHealthy

isHealthy(): boolean
Check if client is available and healthy

Returns boolean
- Defined in src/services/temporal-client.service.ts:433

onModuleInit

onModuleInit(): Promise<void>
Returns Promise<void>
Implementation of OnModuleInit.onModuleInit
- Defined in src/services/temporal-client.service.ts:59

queryWorkflow

queryWorkflow<T = unknown>(
    workflowId: string,
    queryName: string,
    args?: readonly unknown[],
    runId?: string,
): Promise<T>
Query a workflow for its current state
Type Parameters
- T = unknown
Parameters
- workflowId: string
- queryName: string
- Optionalargs: readonly unknown[]
- OptionalrunId: string
Returns Promise<T>
- Defined in src/services/temporal-client.service.ts:376

queryWorkflowHandle

queryWorkflowHandle<T = unknown>(
    handle: WorkflowHandle,
    queryName: string,
    args?: readonly unknown[],
): Promise<T>
Query a workflow using handle
Type Parameters
- T = unknown
Parameters
- handle: WorkflowHandle
- queryName: string
- Optionalargs: readonly unknown[]
Returns Promise<T>
- Defined in src/services/temporal-client.service.ts:399

signalWithStart

signalWithStart(
    workflowType: string,
    signalName: string,
    signalArgs: readonly unknown[],
    workflowArgs: readonly unknown[],
    options?: WorkflowStartOptions,
): Promise<WorkflowHandleWithMetadata>
Atomically start a workflow and send a signal to it.

If the workflow is already running, only the signal is delivered. This is Temporal's signalWithStart operation — useful for ensuring a workflow is running before sending a signal without a race condition.
Parameters
- workflowType: string
  Temporal workflow type name
- signalName: string
  Signal name (string) to send
- signalArgs: readonly unknown[]
  Arguments for the signal
- workflowArgs: readonly unknown[]
  Arguments to start the workflow with (used only when starting)
- Optionaloptions: WorkflowStartOptions
  Workflow start options (taskQueue, workflowId, etc.)
Returns Promise<WorkflowHandleWithMetadata>
Example: Ensure a cart workflow is running, then apply an item
```
// Idempotent: starts the cart the first time, signals it every time.
await clientService.signalWithStart(
  'cartWorkflow',
  'addItem',
  [{ sku: 'SKU-123', qty: 2 }],
  [userId],                                 // args passed to cartWorkflow on first start
  { workflowId: `cart-${userId}`, taskQueue: 'carts' },
);
```
Example: With reuse policy and timeouts
```
const handle = await clientService.signalWithStart(
  'orderWorkflow',
  'approve',
  ['manager-approval'],
  [orderId, customerId],
  {
    workflowId: `order-${orderId}`,
    taskQueue: 'orders',
    workflowIdReusePolicy: 'ALLOW_DUPLICATE',
    workflowExecutionTimeout: '1h',
    memo: { source: 'api' },
  },
);
console.log(`Signaled + maybe-started: ${handle.workflowId}`);
```
- Defined in src/services/temporal-client.service.ts:321

signalWorkflow

signalWorkflow(
    workflowId: string,
    signalName: string,
    args?: readonly unknown[],
    runId?: string,
): Promise<void>
Send a signal to a workflow
Parameters
- workflowId: string
- signalName: string
- Optionalargs: readonly unknown[]
- OptionalrunId: string
Returns Promise<void>
- Defined in src/services/temporal-client.service.ts:239

signalWorkflowHandle

signalWorkflowHandle(
    handle: WorkflowHandle,
    signalName: string,
    args?: readonly unknown[],
): Promise<void>
Send a signal using workflow handle
Parameters
- handle: WorkflowHandle
- signalName: string
- Optionalargs: readonly unknown[]
Returns Promise<void>
- Defined in src/services/temporal-client.service.ts:264

startWorkflow

startWorkflow(
    workflowType: string,
    args?: readonly unknown[],
    options?: WorkflowStartOptions,
): Promise<WorkflowHandleWithMetadata>
Start a new workflow execution
Parameters
- workflowType: string
- args: readonly unknown[] = []
- Optionaloptions: WorkflowStartOptions
Returns Promise<WorkflowHandleWithMetadata>
- Defined in src/services/temporal-client.service.ts:84

terminateWorkflow

terminateWorkflow(
    workflowId: string,
    reason?: string,
    runId?: string,
): Promise<void>
Terminate a workflow execution
Parameters
- workflowId: string
- Optionalreason: string
- OptionalrunId: string
Returns Promise<void>
- Defined in src/services/temporal-client.service.ts:205

Class TemporalClientService

Example

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns TemporalClientService

Methods

cancelWorkflow

Parameters

Returns Promise<void>

getHealth

Returns ClientHealthStatus

getRawClient

Returns Client | null

getStatus

Returns ClientServiceStatus

getWorkflowHandle

Parameters

Returns Promise<WorkflowHandle<Workflow>>

getWorkflowResult

Type Parameters

Parameters

Returns Promise<T>

isHealthy

Returns boolean

onModuleInit

Returns Promise<void>

queryWorkflow

Type Parameters

Parameters

Returns Promise<T>

queryWorkflowHandle

Type Parameters

Parameters

Returns Promise<T>

signalWithStart

Parameters

Returns Promise<WorkflowHandleWithMetadata>

Example: Ensure a cart workflow is running, then apply an item

Example: With reuse policy and timeouts

signalWorkflow

Parameters

Returns Promise<void>

signalWorkflowHandle

Parameters

Returns Promise<void>

startWorkflow

Parameters

Returns Promise<WorkflowHandleWithMetadata>

terminateWorkflow

Parameters

Returns Promise<void>

Settings

On This Page