SchedulerService.createScheduledTaskRunner()

Home > @backstage/backend-plugin-api > SchedulerService > createScheduledTaskRunner

Creates a scheduled but dormant recurring task, ready to be launched at a later time.

Signature:

createScheduledTaskRunner(schedule: SchedulerServiceTaskScheduleDefinition): SchedulerServiceTaskRunner;

Parameters

Parameter	Type	Description
schedule	SchedulerServiceTaskScheduleDefinition	The task schedule

Returns:

SchedulerServiceTaskRunner

Remarks

This method is useful for pre-creating a schedule in outer code to be passed into an inner implementation, such that the outer code controls scheduling while inner code controls implementation.