Skip to main content

XpmActions.substitutionsVariables property

The variables available for substitution in action definitions.

Signature

readonly substitutionsVariables: XpmLiquidSubstitutionsVariables;

Remarks

This comprehensive variable hierarchy provides context for template evaluation, including package metadata, build configuration properties, environment variables, platform detection, and path utilities.

The hierarchy structure:

  1. Base variables: env, os, path (always available).
  2. Package variables: name, version, dependencies, devDependencies.
  3. Configuration variables: build folder paths, compiler settings.
  4. Properties: custom key-value pairs from package or configuration.
  5. Matrix: parameter combinations for template-generated actions (added per action during initialisation).

These variables are accessible in Liquid templates using dot notation (e.g., {{ package.name }}, {{ configuration.buildFolderRelativePath }}).


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