XpmAction.initialise() method

Completes the async initialisation of the action.

Signature

initialise(): Promise<boolean>;

Returns

Promise<boolean>

A promise that resolves to true if initialisation was performed, or false if already initialised.

Exceptions

XpmError If command substitution fails.

Remarks

This method performs variable substitution on the action commands using the Liquid templating engine and the available substitution variables, including any matrix parameters for template-generated actions.

The substitution context includes:

1. All package-level substitution variables (configuration, package metadata, platform detection, etc.).
2. Build configuration variables if this action belongs to a configuration.
3. Matrix parameters for template-generated actions, accessible via the matrix namespace (e.g., {{ matrix.arch }}).

Array-based command definitions are joined with newlines before substitution, then split back into individual commands after processing. This allows commands to span multiple array elements while maintaining clean formatting in the package manifest.

---

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