Skip to main content

PluginTaskScheduler.createScheduledTaskRunner()

Home > @backstage/backend-tasks > PluginTaskScheduler > createScheduledTaskRunner

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

Signature:

createScheduledTaskRunner(schedule: TaskScheduleDefinition): TaskRunner;

Parameters

ParameterTypeDescription
scheduleTaskScheduleDefinitionThe task schedule

Returns:

TaskRunner

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.