Skip to main content

InitTemplateConstructorParameters interface

Configuration parameters for constructing an xpm init template.

Signature

export interface InitTemplateConstructorParameters

Remarks

This interface defines the required configuration for creating an instance of InitTemplateBase or its derived classes. All properties are mandatory except for the optional process parameter, parameter, which defaults to the global Node.js process object when not specified.

The parameters provide the template with access to the xpm context, file system paths, property definitions, and the process environment necessary for template operations.

Properties

Property

Modifiers

Type

Description

__dirname

string

The absolute path to the module folder.

context

Context

The xpm context containing configuration and logging utilities.

options?

LiquidOptions

(Optional) Optional configuration options for the Liquid templating engine.

policies

Policies

The policy flags instance that governs template behaviour.

process?

NodeJS.Process

(Optional) The Node.js process object (defaults to the global process). Intended for testing purposes to allow mocking of process properties and methods.

propertiesDefinitions

InitTemplatePropertiesDefinitions

Definitions of all properties supported by this template.

templatesPath

string

The absolute path to the templates folder.


Generated via tsdoc2docusaurus 1.3.2 by API Extractor/Documenter 7.57.2.