Skip to main content

XpmBuildConfiguration.isHidden property

Indicates whether the configuration is hidden.

Signature

readonly isHidden: boolean;

Remarks

Hidden configurations are used for inheritance bases or intermediate configurations that shouldn't be directly selected for building.

Effects of hidden status:

  1. Hidden configurations don't compute build folder relative paths during initialisation (optimization for inheritance-only configs).
  2. May be excluded from user-facing configuration lists depending on application logic.
  3. Still fully initialised and available for inheritance by other configurations.
  4. Derived from hidden field in JSON configuration definition (defaults to false).

Common use case:

Base configurations that define common properties, dependencies, or actions inherited by multiple concrete configurations.


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