Skip to main content

JsonXpmPackage interface

Represents a JSON xpm package.json structure.

Signature

export interface JsonXpmPackage extends JsonNpmPackage

Extends: JsonNpmPackage

Remarks

Combines standard npm package.json properties with xpm-specific extensions via the required xpack section. All xpm packages are valid npm packages, but not all npm packages are xpm packages.

An xpm package can be:

  • A source package: Provides reusable code or resources for other packages. It contains code, build configurations, and actions.
  • A binary package: Distributes pre-built binaries for multiple platforms with automated installation.

The presence of the xpack section enables xpm-specific features like template-based build configurations, matrix expansion, property substitution, and platform-specific binary distribution. Standard npm fields (name, version, etc.) are used for package identification.

Properties

Property

Modifiers

Type

Description

xpack

JsonXpack

The xpm-specific configuration section.


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