ScaffolderApi.scaffold()

Home > @backstage/plugin-scaffolder-react > ScaffolderApi > scaffold

Executes the scaffolding of a component, given a template and its parameter values.

Signature:

scaffold(options: ScaffolderScaffoldOptions): Promise<ScaffolderScaffoldResponse>;

Parameters

Parameter	Type	Description
options	ScaffolderScaffoldOptions	The ScaffolderScaffoldOptions the scaffolding.

**Returns:**

Promise<ScaffolderScaffoldResponse>