Class TemporalService

Main unified service for Temporal operations Provides a single interface to access all Temporal functionality

Implements

OnModuleInit
OnModuleDestroy

Constructors

constructor

new TemporalService(
    options: TemporalOptions,
    clientService: TemporalClientService,
    workerService: TemporalWorkerManagerService,
    scheduleService: TemporalScheduleService,
    discoveryService: TemporalDiscoveryService,
    metadataAccessor: TemporalMetadataAccessor,
): TemporalService
Parameters
- options: TemporalOptions
- clientService: TemporalClientService
- workerService: TemporalWorkerManagerService
- scheduleService: TemporalScheduleService
- discoveryService: TemporalDiscoveryService
- metadataAccessor: TemporalMetadataAccessor
Returns TemporalService
- Defined in src/services/temporal.service.ts:42

Accessors

activity

get activity(): TemporalDiscoveryService
Get the discovery service instance (for activities)

Returns TemporalDiscoveryService
- Defined in src/services/temporal.service.ts:908

Methods

cancelWorkflow

cancelWorkflow(workflowId: string): Promise<WorkflowCancellationResult>
Cancel a workflow
Parameters
- workflowId: string
Returns Promise<WorkflowCancellationResult>
- Defined in src/services/temporal.service.ts:311

executeActivity

executeActivity<T = unknown>(
name: string,
...args: unknown[],
): Promise<ActivityExecutionResult<T>>
Execute an activity
Type Parameters
- T = unknown
Parameters
- name: string
- ...args: unknown[]
Returns Promise<ActivityExecutionResult<T>>
- Defined in src/services/temporal.service.ts:454

extractActivityMethods

extractActivityMethods(target: Function): ActivityMethodInfo[]
Extract activity methods from a class
Parameters
- target: Function
Returns ActivityMethodInfo[]
- Defined in src/services/temporal.service.ts:552

getActivity

getActivity(name: string): Function | undefined
Get activity by name
Parameters
- name: string
Returns Function | undefined
- Defined in src/services/temporal.service.ts:485

getActivityMetadata

getActivityMetadata(target: Function): MetadataInfo | null
Get activity metadata
Parameters
- target: Function
Returns MetadataInfo | null
- Defined in src/services/temporal.service.ts:544

getActivityNames

getActivityNames(): string[]
Get activity names

Returns string[]
- Defined in src/services/temporal.service.ts:509

getAllActivities

getAllActivities(): Record<string, Function>
Get all activities

Returns Record<string, Function>
- Defined in src/services/temporal.service.ts:493

getAllWorkers

getAllWorkers(): MultipleWorkersInfo | null
Get all workers information (for multiple workers setup)

Returns MultipleWorkersInfo | null
- Defined in src/services/temporal.service.ts:395

getHealth

getHealth(): {
    isInitialized: boolean;
    namespace: string;
    services: {
        activity: ServiceHealth;
        client: ServiceHealth;
        discovery: ServiceHealth;
        schedule: ServiceHealth;
        worker: ServiceHealth;
    };
    status: "healthy"
    | "unhealthy"
    | "degraded";
    summary: {
        clientConnected: boolean;
        totalActivities: number;
        totalSchedules: number;
        workerRunning: boolean;
    };
}
Get comprehensive health status

Returns {
    isInitialized: boolean;
    namespace: string;
    services: {
        activity: ServiceHealth;
        client: ServiceHealth;
        discovery: ServiceHealth;
        schedule: ServiceHealth;
        worker: ServiceHealth;
    };
    status: "healthy"
    | "unhealthy"
    | "degraded";
    summary: {
        clientConnected: boolean;
        totalActivities: number;
        totalSchedules: number;
        workerRunning: boolean;
    };
}
- Defined in src/services/temporal.service.ts:650

getOverallHealth

getOverallHealth(): Promise<OverallHealthStatus>
Get overall health status (async version for compatibility)

Returns Promise<OverallHealthStatus>
- Defined in src/services/temporal.service.ts:559

getStats

getStats(): ServiceStatistics
Get service statistics

Returns ServiceStatistics
- Defined in src/services/temporal.service.ts:716

getWorker

getWorker(taskQueue: string): Worker | null
Get a specific worker by task queue (for multiple workers setup)
Parameters
- taskQueue: string
Returns Worker | null
- Defined in src/services/temporal.service.ts:384

getWorkerHealth

getWorkerHealth(): Promise<
    {
        details?: WorkerStatus;
        status: "healthy"
        | "unhealthy"
        | "degraded"
        | "not_available";
    },
>
Get worker health status

Returns Promise<
    {
        details?: WorkerStatus;
        status: "healthy"
        | "unhealthy"
        | "degraded"
        | "not_available";
    },
>
- Defined in src/services/temporal.service.ts:610

getWorkerManager

getWorkerManager(): TemporalWorkerManagerService
Get the worker manager service (provides access to getConnection())

Returns TemporalWorkerManagerService
- Defined in src/services/temporal.service.ts:377

getWorkerStatus

getWorkerStatus(): WorkerStatus | null
Get worker status

Returns WorkerStatus | null
- Defined in src/services/temporal.service.ts:366

getWorkerStatusByTaskQueue

getWorkerStatusByTaskQueue(taskQueue: string): WorkerStatus | null
Get worker status for a specific task queue (for multiple workers setup)
Parameters
- taskQueue: string
Returns WorkerStatus | null
- Defined in src/services/temporal.service.ts:406

getWorkflowHandle

getWorkflowHandle<T = unknown>(workflowId: string, runId?: string): Promise<T>
Get workflow handle
Type Parameters
- T = unknown
Parameters
- workflowId: string
- OptionalrunId: string
Returns Promise<T>
- Defined in src/services/temporal.service.ts:276

hasActivity

hasActivity(name: string): boolean
Check if activity exists
Parameters
- name: string
Returns boolean
- Defined in src/services/temporal.service.ts:501

hasWorker

hasWorker(): boolean
Check if worker is available

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

isActivity

isActivity(target: Function): boolean
Check if a class is an activity
Parameters
- target: Function
Returns boolean
- Defined in src/services/temporal.service.ts:517

isActivityMethod

isActivityMethod(target: object, methodName: string): boolean
Check if a method is an activity method
Parameters
- target: object
- methodName: string
Returns boolean
- Defined in src/services/temporal.service.ts:524

isWorkerRunning

isWorkerRunning(): boolean
Check if worker is running

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

onModuleDestroy

onModuleDestroy(): Promise<void>
Cleanup on module destroy

Returns Promise<void>
Implementation of OnModuleDestroy.onModuleDestroy
- Defined in src/services/temporal.service.ts:101

onModuleInit

onModuleInit(): Promise<TemporalServiceInitResult>
Initialize the unified service

Returns Promise<TemporalServiceInitResult>
Implementation of OnModuleInit.onModuleInit
- Defined in src/services/temporal.service.ts:60

queryWorkflow

queryWorkflow<T = unknown>(
    workflowId: string,
    queryName: string,
    args?: unknown[],
): Promise<WorkflowQueryResult<T>>
Query a workflow
Type Parameters
- T = unknown
Parameters
- workflowId: string
- queryName: string
- Optionalargs: unknown[]
Returns Promise<WorkflowQueryResult<T>>
- Defined in src/services/temporal.service.ts:241

registerWorker

registerWorker(workerDef: WorkerDefinition): Promise<CreateWorkerResult>
Register and create a new worker dynamically at runtime
Parameters
- workerDef: WorkerDefinition
Returns Promise<CreateWorkerResult>
- Defined in src/services/temporal.service.ts:439

signalWorkflow

signalWorkflow(
    workflowId: string,
    signalName: string,
    args?: unknown[],
): Promise<WorkflowSignalResult>
Signal a workflow
Parameters
- workflowId: string
- signalName: string
- Optionalargs: unknown[]
Returns Promise<WorkflowSignalResult>
- Defined in src/services/temporal.service.ts:211

startWorker

startWorker(): Promise<void>
Start the worker

Returns Promise<void>
- Defined in src/services/temporal.service.ts:332

startWorkerByTaskQueue

startWorkerByTaskQueue(taskQueue: string): Promise<void>
Start a specific worker by task queue (for multiple workers setup)
Parameters
- taskQueue: string
Returns Promise<void>
- Defined in src/services/temporal.service.ts:417

startWorkflow

startWorkflow<T = unknown>(
    workflowType: string,
    args?: unknown[],
    options?: WorkflowStartOptions,
): Promise<WorkflowExecutionResult<T>>
Start a workflow execution
Type Parameters
- T = unknown
Parameters
- workflowType: string
- Optionalargs: unknown[]
- Optionaloptions: WorkflowStartOptions
Returns Promise<WorkflowExecutionResult<T>>
- Defined in src/services/temporal.service.ts:181

stopWorker

stopWorker(): Promise<void>
Stop the worker

Returns Promise<void>
- Defined in src/services/temporal.service.ts:340

stopWorkerByTaskQueue

stopWorkerByTaskQueue(taskQueue: string): Promise<void>
Stop a specific worker by task queue (for multiple workers setup)
Parameters
- taskQueue: string
Returns Promise<void>
- Defined in src/services/temporal.service.ts:428

terminateWorkflow

terminateWorkflow(
workflowId: string,
reason?: string,
): Promise<WorkflowTerminationResult>
Terminate a workflow
Parameters
- workflowId: string
- Optionalreason: string
Returns Promise<WorkflowTerminationResult>
- Defined in src/services/temporal.service.ts:285

Class TemporalService

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns TemporalService

Accessors

activity

Returns TemporalDiscoveryService

client

Returns TemporalClientService

discovery

Returns TemporalDiscoveryService

metadata

Returns TemporalMetadataAccessor

schedule

Returns TemporalScheduleService

worker

Returns TemporalWorkerManagerService

Methods

cancelWorkflow

Parameters

Returns Promise<WorkflowCancellationResult>

executeActivity

Type Parameters

Parameters

Returns Promise<ActivityExecutionResult<T>>

extractActivityMethods

Parameters

Returns ActivityMethodInfo[]

getActivity

Parameters

Returns Function | undefined

getActivityMetadata

Parameters

Returns MetadataInfo | null

getActivityNames

Returns string[]

getAllActivities

Returns Record<string, Function>

getAllWorkers

Returns MultipleWorkersInfo | null

getHealth

getOverallHealth

Returns Promise<OverallHealthStatus>

getStats

Returns ServiceStatistics

getWorker

Parameters

Returns Worker | null

getWorkerHealth

Returns Promise< { details?: WorkerStatus; status: "healthy" | "unhealthy" | "degraded" | "not_available"; },>

getWorkerManager

Returns TemporalWorkerManagerService

getWorkerStatus

Returns WorkerStatus | null

getWorkerStatusByTaskQueue

Parameters

Returns WorkerStatus | null

getWorkflowHandle

Type Parameters

Parameters

Returns Promise<T>

hasActivity

Parameters

Returns boolean

hasWorker

Returns boolean

isActivity

Parameters

Returns boolean

isActivityMethod

Parameters

Returns boolean

isWorkerRunning

Returns boolean

Returns Promise<
{
details?: WorkerStatus;
status: "healthy"
| "unhealthy"
| "degraded"
| "not_available";
},
>