Class TemporalScheduleService

Service for managing Temporal schedules including creating, updating, and monitoring scheduled workflows

Implements

OnModuleInit
OnModuleDestroy

Index

Constructors

Methods

createSchedule getHealth getSchedule getScheduleStats getStatus isHealthy onModuleDestroy onModuleInit

Constructors

constructor

new TemporalScheduleService(
    options: TemporalOptions,
    client: { connection?: TemporalConnection; schedule?: ScheduleClient },
    discoveryService: DiscoveryService,
    metadataAccessor: TemporalMetadataAccessor,
): TemporalScheduleService
Parameters
- options: TemporalOptions
- client: { connection?: TemporalConnection; schedule?: ScheduleClient }
- discoveryService: DiscoveryService
- metadataAccessor: TemporalMetadataAccessor
Returns TemporalScheduleService
- Defined in src/services/temporal-schedule.service.ts:37

Methods

createSchedule

createSchedule(
options: ScheduleCreationOptions,
): Promise<ScheduleCreationResult>
Create a new schedule
Parameters
- options: ScheduleCreationOptions
Returns Promise<ScheduleCreationResult>
- Defined in src/services/temporal-schedule.service.ts:415

getHealth

getHealth(): ScheduleServiceHealth
Get service health status

Returns ScheduleServiceHealth
- Defined in src/services/temporal-schedule.service.ts:537

getSchedule

getSchedule(scheduleId: string): Promise<ScheduleRetrievalResult>
Get a schedule handle
Parameters
- scheduleId: string
Returns Promise<ScheduleRetrievalResult>
- Defined in src/services/temporal-schedule.service.ts:476

getScheduleStats

getScheduleStats(): ScheduleServiceStats
Get schedule statistics

Returns ScheduleServiceStats
- Defined in src/services/temporal-schedule.service.ts:512

getStatus

getStatus(): ScheduleServiceStatus
Get service status

Returns ScheduleServiceStatus
- Defined in src/services/temporal-schedule.service.ts:525

isHealthy

isHealthy(): boolean
Check if service is healthy

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

onModuleDestroy

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

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

onModuleInit

onModuleInit(): Promise<void>
Initialize the schedule service

Returns Promise<void>
Implementation of OnModuleInit.onModuleInit
- Defined in src/services/temporal-schedule.service.ts:67