ScaffolderApi.cancelTask()

Home > @backstage/plugin-scaffolder-common > ScaffolderApi > cancelTask

Sends a signal to a task broker to cancel the running task by taskId.

Signature:

cancelTask(taskId: string, options?: ScaffolderRequestOptions): Promise<{
        status?: ScaffolderTaskStatus;
    }>;

Parameters

Parameter	Type	Description
taskId	string	the id of the task
options	ScaffolderRequestOptions	(Optional)

**Returns:**

Promise<{ status?: ScaffolderTaskStatus; }>