Skip to content
View as Markdown
View as Markdown

@salesforce/b2c-tooling-sdk / scaffold / ScaffoldEngine

Class: ScaffoldEngine

Defined in: packages/b2c-tooling-sdk/src/scaffold/engine.ts:137

Scaffold template engine

Constructors

Constructor

new ScaffoldEngine(variables): ScaffoldEngine

Defined in: packages/b2c-tooling-sdk/src/scaffold/engine.ts:140

Parameters

variables

Record<string, string | boolean | string[]>

Returns

ScaffoldEngine

Methods

getContext()

getContext(): TemplateContext

Defined in: packages/b2c-tooling-sdk/src/scaffold/engine.ts:147

Get the current template context

Returns

TemplateContext


render()

render(template): string

Defined in: packages/b2c-tooling-sdk/src/scaffold/engine.ts:156

Render an EJS template string using the current context.

Parameters

template

string

The EJS template string to render

Returns

string

The rendered string


renderFile()

renderFile(filePath): Promise<string>

Defined in: packages/b2c-tooling-sdk/src/scaffold/engine.ts:176

Render an EJS template file asynchronously.

Parameters

filePath

string

Path to the EJS template file

Returns

Promise<string>

Promise resolving to the rendered template output as a string


renderPath()

renderPath(pathTemplate): string

Defined in: packages/b2c-tooling-sdk/src/scaffold/engine.ts:167

Render a file path template using double-brace placeholder syntax. Supports direct variable references (double-brace name double-brace) and helper function calls (e.g. double-brace kebabCase moduleName double-brace).

Parameters

pathTemplate

string

The path template string with double-brace placeholders

Returns

string

The rendered path string with placeholders replaced by context values

Released under the Apache-2.0 License.