Skip to main content

ActionsConstructorParameters interface

Configuration parameters for constructing an actions collection instance.

Signature

export interface ActionsConstructorParameters

Remarks

This interface defines the required configuration for creating an instance of Actions. Most properties are mandatory except for the optional inheritedActionsMap and buildConfiguration parameters.

The parameters provide the actions collection with access to the Liquid templating engine, substitution variables hierarchy, action definitions from the package manifest, optional inherited actions from a parent package, optional build configuration context, and the logger for diagnostic output.

Properties

Property

Modifiers

Type

Description

buildConfiguration?

BuildConfiguration

(Optional) Optional build configuration this actions collection belongs to.

engine

LiquidEngine

The Liquid templating engine for variable substitution.

inheritedActionsMap?

Map<string, Action>

(Optional) Optional map of actions inherited from a parent package.

jsonActions

JsonActions | undefined

The JSON object containing action definitions, or undefined if there are no actions.

log

Logger

The logger instance for output and diagnostics.

substitutionsVariables

LiquidSubstitutionsVariables

The variables available for substitution in action definitions.


Generated via tsdoc2docusaurus 1.3.2 by API Extractor/Documenter 7.57.2.