@backstage/backend-tasks

Common distributed task management library for Backstage backends

Classes

Class	Description
TaskScheduler	Deals with the scheduling of distributed tasks.

Function	Description
readTaskScheduleDefinitionFromConfig(config)	Reads a TaskScheduleDefinition from a Config. Expects the config not to be the root config, but the config for the definition.

Interface	Description
PluginTaskScheduler	Deals with the scheduling of distributed tasks, for a given plugin.
TaskInvocationDefinition	Options that apply to the invocation of a given task.
TaskRunner	A previously prepared task schedule, ready to be invoked.
TaskScheduleDefinition	Options that control the scheduling of a task.
TaskScheduleDefinitionConfig	Config options for TaskScheduleDefinition that control the scheduling of a task.

Type Alias	Description
HumanDuration	Human friendly durations object.
TaskDescriptor	A semi-opaque type to describe an actively scheduled task.
TaskFunction	A function that can be called as a scheduled task. It may optionally accept an abort signal argument. When the signal triggers, processing should abort and return as quickly as possible.

Type Alias

Description

Human friendly durations object.

A semi-opaque type to describe an actively scheduled task.

A function that can be called as a scheduled task.

It may optionally accept an abort signal argument. When the signal triggers, processing should abort and return as quickly as possible.