Skip to main content

XpmDataModel.substitutionsVariables property

The variables available for Liquid substitutions.

Signature

readonly substitutionsVariables: XpmLiquidSubstitutionsVariables;

Remarks

This sealed object provides the base substitution context inherited by all actions and build configurations within the package.

Variable hierarchy:

  1. Base variables (xpmLiquidSubstitutionsVariablesBase):
    • env: Environment variables from process.env
    • os: Platform detection (platform, arch, endianness, version)
    • path: Path utilities (sep, delimiter, cwd)
  2. Package metadata:
    • package: Complete package.json content (name, version, dependencies, etc.)
  3. User-defined properties:
    • properties: Merged from xpack.properties if present

The object is sealed after initialization to prevent accidental modification. Child components (actions and configurations) extend this context with their own scoped variables (configuration, matrix) without modifying the original sealed object.


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