ScaffolderApi
Home > @backstage/plugin-scaffolder-react > ScaffolderApi
An API to interact with the scaffolder backend.
Signature:
export interface ScaffolderApi
Methods
| Method | Description |
|---|---|
| cancelTask(taskId) | Sends a signal to a task broker to cancel the running task by taskId. |
| dryRun(options)? | (Optional) |
| getIntegrationsList(options) | |
| getTask(taskId) | |
| getTemplateParameterSchema(templateRef) | |
| listActions() | Returns a list of all installed actions. |
| listTasks(options)? | (Optional) |
| scaffold(options) | Executes the scaffolding of a component, given a template and its parameter values. |
| streamLogs(options) |