Skip to main content

XpmBuildConfigurations._createSubstitutedBuildConfiguration() method

Creates a substituted build configuration from a template combination.

Signature

protected _createSubstitutedBuildConfiguration({ buildConfigurationName, jsonBuildConfiguration, combination, newBuildConfigurationsMap, }: {
buildConfigurationName: string;
jsonBuildConfiguration: JsonBuildConfigurationContent;
combination: Record<string, string>;
newBuildConfigurationsMap: Map<string, XpmBuildConfiguration>;
}): Promise<void>;

Parameters

Parameter

Type

Description

{ buildConfigurationName, jsonBuildConfiguration, combination, newBuildConfigurationsMap, }

{ buildConfigurationName: string; jsonBuildConfiguration: JsonBuildConfigurationContent; combination: Record<string, string>; newBuildConfigurationsMap: Map<string, XpmBuildConfiguration>; }

Returns

Promise<void>

A promise that resolves when the configuration has been created and registered.

Exceptions

XpmError If substitutions fail during build configuration name expansion.

Remarks

This helper method is invoked during template expansion for each matrix combination to generate concrete build configuration instances from the template definition.

Processing steps:

  1. Perform Liquid substitutions on the template build configuration name using the matrix combination values.
  2. Create a new XpmBuildConfiguration instance with the substituted name and matrix parameters.
  3. Register the new configuration in the provided map for subsequent collection integration.

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