JsonXpmBinaries interface

Represents a JSON binaries definition in package.json.

Signature

export interface JsonXpmBinaries

Remarks

Configures binary package distribution for tools, SDKs, or compiled applications. xpm downloads platform-specific archives, verifies their integrity, and extracts them to the specified destination.

Example usage in package.json:

"binaries": {
  "destination": ".content",
  "baseUrl": "https://github.com/org/repo/releases/download/v1.0.0",
  "skip": 1,
  "platforms": {
    "linux-x64": {
      "fileName": "tool-linux-x64.tar.gz",
      "sha256": "abc123..."
    }
  }
}

The skip parameter removes leading path segments from archive entries during extraction, useful for archives with wrapper folders. Checksums ensure downloaded files haven't been corrupted or tampered with.

Properties

Property	Modifiers	Type	Description
baseUrl		string	The base URL used to download binaries.
destination		string	The destination folder for extracted binaries.
platforms		JsonXpmBinariesPlatforms	The platforms map for available binaries.
skip?		number	(Optional) The number of path segments to skip when extracting.

---

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