Developer Preview — This project is in active development. APIs may change. Provide feedback
Skip to content

@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:154

Render an EJS template string

Parameters

template

string

Returns

string


renderFile()

renderFile(filePath): Promise<string>

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

Render an EJS template file

Parameters

filePath

string

Returns

Promise<string>


renderPath()

renderPath(pathTemplate): string

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

Render a file path template

Parameters

pathTemplate

string

Returns

string

Released under the Apache-2.0 License.