XpmPackage.isBinaryXpmPackage() method

Determines whether the package is a binary xpm package.

Signature

isBinaryXpmPackage(): boolean;

Returns

boolean

true if the package defines binaries and executables, false otherwise.

Exceptions

XpmInputError If required binary package fields are missing.

Remarks

Binary packages must have both executables and binaries. The presence of one implies the other, so this method validates consistency.

Validation rules:

1. If xpack.executables (or deprecated xpack.bin) exists, then xpack.binaries and xpack.binaries.platforms must also exist.
2. If xpack.binaries exists, then xpack.binaries.platforms and xpack.executables (or deprecated xpack.bin) must also exist.

This bidirectional validation ensures package metadata consistency and catches incomplete binary package configurations early. The check helps prevent runtime errors when attempting to install or use binary packages with missing metadata.

---

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