Skip to main content

JsonTemplateMatrix type alias

Represents a matrix of parameters for template expansion.

Signature​

export type JsonTemplateMatrix = Record<string, JsonTemplateMatrixContent>;

References: JsonTemplateMatrixContent

Remarks​

The matrix defines parameter arrays used to generate multiple template variants through Cartesian product expansion. Each key represents a parameter name, and its value is an array of possible values for that parameter.

Matrix expansion rules:

  • Each parameter array is combined with all others to create every possible combination.
  • Matrix values are accessible in template names and template content via {{ matrix.parameterName }} Liquid syntax.
  • The number of generated template variants equals the product of all array lengths.

Example:

{
  "os": ["linux", "darwin"],
  "arch": ["x64", "arm64"]
}

This generates 4 template variants (2 × 2): linux-x64, linux-arm64, darwin-x64, darwin-arm64.

Generated via tsdoc2docusaurus 1.3.2 by API Extractor/Documenter 7.57.2.

Last updated on