XpmBuildConfigurations._expandTemplateBuildConfigurations() method

Expands a template build configuration into multiple configurations.

Signature

protected _expandTemplateBuildConfigurations({ buildConfigurationName, jsonBuildConfigurationTemplate, }: {
        buildConfigurationName: string;
        jsonBuildConfigurationTemplate: JsonBuildConfigurationTemplate;
    }): Promise<Map<string, XpmBuildConfiguration>>;

Parameters

Parameter	Type	Description
{ buildConfigurationName, jsonBuildConfigurationTemplate, }	{ buildConfigurationName: string; jsonBuildConfigurationTemplate: JsonBuildConfigurationTemplate; }

Returns

Promise<Map<string, XpmBuildConfiguration>>

A promise that resolves to a map of expanded configuration names to their corresponding instances.

Exceptions

XpmError If the matrix structure is invalid or substitution fails.

Remarks

This method computes the Cartesian product of matrix parameter values and creates a configuration for each combination, substituting matrix values into both the configuration name and content.

Processing steps:

1. Validates matrix structure (object with array values).
2. Validates template format (must be a JSON object).
3. Performs Liquid substitutions on matrix values if they contain template syntax.
4. Recursively generates all combinations using Cartesian product.
5. Creates a configuration instance for each combination with matrix parameters stored for later full evaluation.

Matrix variables are scoped to individual configurations and accessible via the matrix namespace during property, dependency, and action evaluation.

---

Generated via tsdoc2docusaurus 1.3.0-pre by API Extractor/Documenter 7.55.2.