Skip to main content

InitTemplateBase.render() method

Renders a template file using Liquid and writes the output.

Signature​

render(input: {
        sourceFilePath: string;
        destinationFilePath: string;
        substitutionsVariables?: InitTemplateSubstitutionsVariables;
    }): Promise<void>;

Parameters​

Parameter

Type

Description

{ sourceFilePath, destinationFilePath, substitutionsVariables, }

(not declared)

input

{ sourceFilePath: string; destinationFilePath: string; substitutionsVariables?: InitTemplateSubstitutionsVariables; }

Returns​

Promise<void>

A promise that resolves when the file has been rendered and written.

Exceptions​

OutputError If template rendering fails.

Remarks​

This method processes a template file through the Liquid templating engine with the provided substitution variables, generating the final output file. Parent directories are created automatically if they do not exist. The template file should be located in the templates folder and use Liquid syntax for variable references (e.g., {{ variableName }}).

The substitution variables include all project properties plus additional context like the current year. If substitutionsVariables is not provided, the instance's substitutionsVariables property is used.

Generated via tsdoc2docusaurus 1.3.2 by API Extractor/Documenter 7.57.2.

Last updated on