Class: TemporalHealthModule

Defined in: src/health/temporal-health.module.ts:32

Temporal Health Module

Provides health check endpoints for Temporal components. Import this module to add health check endpoints to your application.

Example

@Module({
  imports: [
    TemporalModule.register({
      connection: { address: 'localhost:7233' },
      taskQueue: 'default'
    }),
    TemporalHealthModule // Add health check endpoints
  ]
})
export class AppModule {}

This will add the following endpoints:

• GET /temporal/health - Overall system health

Constructors

Constructor

new TemporalHealthModule(): TemporalHealthModule

Returns

TemporalHealthModule

Methods

register()

static register(options?): DynamicModule

Defined in: src/health/temporal-health.module.ts:41

Configure the endpoint. detail: 'minimal' exposes only { status, timestamp }.

Parameters

options?

TemporalHealthOptions = {}

Returns

DynamicModule

Example

TemporalHealthModule.register({ detail: 'minimal' })