JsonXpack interface

Represents a JSON xpm-specific section in package.json.

Signature

export interface JsonXpack

Remarks

The xpack section extends standard npm package.json with xpm-specific metadata for binary package management, build automation, and cross-platform development workflows.

Key capabilities:

• Binary packages: Define platform-specific binary distributions with download URLs, checksums, and installation configuration.
• Build configurations: Organize multiple build targets (debug, release, platform variants) with inherited properties and dependencies.
• Actions: Define build automation commands that can reference properties and build configuration context via Liquid templates.
• Properties: User-defined configuration values accessible throughout the package via template substitution.
• Version requirements: Specify minimum xpm version for feature compatibility and policy enforcement.

The xpack section is optional in npm packages but required for packages using xpm-specific features like build configurations or binary distributions.

Properties

Property	Modifiers	Type	Description
actions?		JsonActions	(Optional) The action definitions.
bin?		Record<string, string>	(Optional) Deprecated alias of JsonXpack.executables.
binaries?		JsonXpmBinaries	(Optional) The binaries definition, if the package provides binaries.
buildConfigurations?		JsonBuildConfigurations	(Optional) The build configurations map.
dependencies?		JsonDependencies	(Optional) The dependencies map.
devDependencies?		JsonDependencies	(Optional) The development dependencies map.
executables?		Record<string, string>	(Optional) The executables map.
minimumXpmRequired?		string	(Optional) The minimum required xpm version.
properties?		JsonProperties	(Optional) The properties map.

---

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