Skip to main content

XpmBuildConfiguration._getBuildFolderRelativePath() method

Computes the build folder relative path for this configuration.

Signature

protected _getBuildFolderRelativePath(): Promise<string>;

Returns

Promise<string>

A promise that resolves to the build folder relative path.

Remarks

This method resolves the build folder relative path property when provided and uses a default value based on the configuration name otherwise.

Resolution strategy:

  1. Check if buildFolderRelativePath property exists in configuration properties.
  2. If present and non-empty, perform Liquid substitutions with the full configuration context.
  3. If substitution fails or property is empty/missing, generate a default path: `build/{filtered-configuration-name}` where the configuration name is sanitized for filesystem compatibility.

The computed path is added back to the properties as buildFolderRelativePath for use in subsequent substitutions.


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