Skip to main content
Version: Next

SchedulerServiceTaskInvocationDefinition

Home > @backstage/backend-plugin-api > SchedulerServiceTaskInvocationDefinition

Options that apply to the invocation of a given task.

Signature:

export interface SchedulerServiceTaskInvocationDefinition 

Properties

Property

Modifiers

Type

Description

fn

SchedulerServiceTaskFunction

The actual task function to be invoked regularly.

id

string

A unique ID (within the scope of the plugin) for the task.

signal?

AbortSignal

(Optional) An abort signal that, when triggered, will stop the recurring execution of the task.