Skip to main content

XpmAction._matrixParameters property

The matrix parameter values for template-generated actions.

Signature

protected readonly _matrixParameters?: XpmLiquidSubstitutionsStrings;

Remarks

For template-generated actions, this object contains the specific matrix parameter values that produced this action instance from the template.

Usage pattern:

  1. Undefined for regular (non-template) actions.
  2. For template actions, contains key-value pairs from the matrix combination (e.g., { arch: 'x64', platform: 'linux' }).
  3. Merged into substitution variables during XpmAction.initialise(), making values accessible via the matrix namespace in command templates.
  4. Enables the same command template to generate different concrete commands for each matrix combination.

Example: A template with {{ matrix.arch }} becomes x64 when this action's matrix parameters include { arch: 'x64' }.


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