Skip to main content

JsonDependencyExtended interface

Represents a JSON extended dependency definition.

Signature

export interface JsonDependencyExtended

Remarks

Extended dependency format introduced in xpm 0.16.0 to support richer dependency metadata beyond simple version strings. Allows specifying platform constraints and local installation modes.

Example usage in package.json:

"dependencies": {
"@scope/package": {
"specifier": "^1.0.0",
"platforms": ["linux-x64", "darwin-x64"],
"local": "link"
}
}

Platform filtering enables platform-specific dependencies, useful for binary packages that only work on certain operating systems or architectures. Local installation modes control how dependencies are installed in the workspace (symbolic link vs. file copy).

Properties

Property

Modifiers

Type

Description

local?

'link' | 'copy'

(Optional) The local installation mode, if applicable.

platforms?

string | string[]

(Optional) The supported platforms for the dependency.

specifier

string

The dependency version specifier.


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