ScaffolderApi.scaffold()

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

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

Signature:

scaffold(request: ScaffolderScaffoldOptions, options?: ScaffolderRequestOptions): Promise<ScaffolderScaffoldResponse>;

Parameters

Parameter	Type	Description
request	ScaffolderScaffoldOptions
options	ScaffolderRequestOptions	(Optional) The ScaffolderScaffoldOptions the scaffolding.

**Returns:**

Promise<ScaffolderScaffoldResponse>