Class TemporalScheduleService

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

Implements

OnModuleInit
OnModuleDestroy

Index

Constructors

Methods

createSchedule deleteSchedule describeSchedule getHealth getSchedule getScheduleStats getStatus isHealthy listSchedules onModuleDestroy onModuleInit pauseSchedule triggerSchedule unpauseSchedule updateSchedule upsertSchedule

Constructors

constructor

new TemporalScheduleService(
    options: TemporalOptions,
    client: Client | null,
    discoveryService: DiscoveryService,
    metadataAccessor: TemporalMetadataAccessor,
): TemporalScheduleService
Parameters
- options: TemporalOptions
- client: Client | null
- discoveryService: DiscoveryService
- metadataAccessor: TemporalMetadataAccessor
Returns TemporalScheduleService
- Defined in src/services/temporal-schedule.service.ts:55

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:515

deleteSchedule

deleteSchedule(scheduleId: string): Promise<ScheduleOperationResult>
Delete a schedule.
Parameters
- scheduleId: string
Returns Promise<ScheduleOperationResult>
Example
```
await scheduleService.deleteSchedule('daily-report');
```
- Defined in src/services/temporal-schedule.service.ts:737

describeSchedule

describeSchedule(scheduleId: string): Promise<ScheduleDescribeResult>
Describe a schedule, returning its current configuration and state.
Parameters
- scheduleId: string
Returns Promise<ScheduleDescribeResult>
Example
```
const { description } = await scheduleService.describeSchedule('daily-report');
console.log(description?.state.paused);
```
- Defined in src/services/temporal-schedule.service.ts:801

getHealth

getHealth(): ScheduleServiceHealth
Get service health status

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

getSchedule

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

getScheduleStats

getScheduleStats(): ScheduleServiceStats
Get schedule statistics

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

getStatus

getStatus(): ScheduleServiceStatus
Get service status

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

isHealthy

isHealthy(): boolean
Check if service is healthy

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

listSchedules

listSchedules(options?: ListScheduleOptions): ScheduleListResult
List schedules in the namespace, wrapped in a result envelope so callers can distinguish "schedule client unavailable" from "no schedules found".
Parameters
- Optionaloptions: ListScheduleOptions
Returns ScheduleListResult
Example
```
const { schedules } = scheduleService.listSchedules();
for await (const schedule of schedules ?? []) {
  console.log(schedule.scheduleId);
}
```
- Defined in src/services/temporal-schedule.service.ts:831

onModuleDestroy

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

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

onModuleInit

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

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

pauseSchedule

pauseSchedule(
scheduleId: string,
note?: string,
): Promise<ScheduleOperationResult>
Pause a schedule so it no longer takes actions.
Parameters
- scheduleId: string
- Optionalnote: string
Returns Promise<ScheduleOperationResult>
Example
```
await scheduleService.pauseSchedule('daily-report', 'investigating an incident');
```
- Defined in src/services/temporal-schedule.service.ts:653

triggerSchedule

triggerSchedule(
scheduleId: string,
overlapPolicy?: ScheduleOverlapPolicy,
): Promise<ScheduleOperationResult>
Trigger an immediate action for a schedule, outside its normal specification.
Parameters
- scheduleId: string
- OptionaloverlapPolicy: ScheduleOverlapPolicy
Returns Promise<ScheduleOperationResult>
Example
```
await scheduleService.triggerSchedule('daily-report', 'ALLOW_ALL');
```
- Defined in src/services/temporal-schedule.service.ts:707

unpauseSchedule

unpauseSchedule(
scheduleId: string,
note?: string,
): Promise<ScheduleOperationResult>
Unpause a schedule, resuming its actions.
Parameters
- scheduleId: string
- Optionalnote: string
Returns Promise<ScheduleOperationResult>
Example
```
await scheduleService.unpauseSchedule('daily-report');
```
- Defined in src/services/temporal-schedule.service.ts:680

updateSchedule

updateSchedule(
scheduleId: string,
updateFn: (previous: ScheduleDescription) => ScheduleUpdateOptions,
): Promise<ScheduleOperationResult>
Update a schedule's definition. updateFn receives the current description and must return the new desired schedule options — mirrors the SDK's describe-then-transform ScheduleHandle.update() pattern.
Parameters
- scheduleId: string
- updateFn: (previous: ScheduleDescription) => ScheduleUpdateOptions
Returns Promise<ScheduleOperationResult>
Example
```
await scheduleService.updateSchedule('daily-report', (previous) => ({
  ...previous,
  spec: { ...previous.spec, cronExpressions: ['0 9 * * *'] },
}));
```
- Defined in src/services/temporal-schedule.service.ts:770

upsertSchedule

upsertSchedule(options: ScheduleCreationOptions): Promise<ScheduleUpsertResult>
Create a schedule, or update it in place if a schedule with the same scheduleId already exists — avoids the SDK's ScheduleAlreadyRunning error on repeated bootstraps (e.g. registering schedules on every app start).
Parameters
- options: ScheduleCreationOptions
Returns Promise<ScheduleUpsertResult>
Example
```
await scheduleService.upsertSchedule({
  scheduleId: 'daily-report',
  spec: { cronExpressions: ['0 9 * * *'] },
  action: { type: 'startWorkflow', workflowType: 'sendDailyReport', taskQueue: 'reports' },
});
```
- Defined in src/services/temporal-schedule.service.ts:554

Class TemporalScheduleService

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns TemporalScheduleService

Methods

createSchedule

Parameters

Returns Promise<ScheduleCreationResult>

deleteSchedule

Parameters

Returns Promise<ScheduleOperationResult>

Example

describeSchedule

Parameters

Returns Promise<ScheduleDescribeResult>

Example

getHealth

Returns ScheduleServiceHealth

getSchedule

Parameters

Returns Promise<ScheduleRetrievalResult>

getScheduleStats

Returns ScheduleServiceStats

getStatus

Returns ScheduleServiceStatus

isHealthy

Returns boolean

listSchedules

Parameters

Returns ScheduleListResult

Example

onModuleDestroy

Returns Promise<void>

onModuleInit

Returns Promise<void>

pauseSchedule

Parameters

Returns Promise<ScheduleOperationResult>

Example

triggerSchedule

Parameters

Returns Promise<ScheduleOperationResult>

Example

unpauseSchedule

Parameters

Returns Promise<ScheduleOperationResult>

Example

updateSchedule

Parameters

Returns Promise<ScheduleOperationResult>

Example

upsertSchedule

Parameters

Returns Promise<ScheduleUpsertResult>

Example

Settings

On This Page