PackageVersion
API reference › Foxy › Native › PackageVersion
Represents one published version of a registry package as read from the abbreviated npm metadata.
Properties
Section titled “Properties”| Property | Type | Description | Defined by |
|---|---|---|---|
$dependencies readonly constructor | array<array-key, | Runtime dependencies keyed by package name. Default: []. | PackageVersion |
$deprecated readonly constructor | string| | Deprecation text, or null when the version is not deprecated. Default: null. | PackageVersion |
$integrity readonly constructor | string | Subresource Integrity value: dist.integrity, or sha1-<base64> derived from dist.shasum. | PackageVersion |
$name readonly constructor | string | Package name. | PackageVersion |
$optionalDependencies readonly constructor | array<array-key, | Optional dependencies keyed by package name. Default: []. | PackageVersion |
$optionalPeerDependencies readonly constructor | list<string> | Peer names whose peerDependenciesMeta entry declares optional: true. Default: []. | PackageVersion |
$peerDependencies readonly constructor | array<array-key, | Peer dependencies keyed by package name. Default: []. | PackageVersion |
$tarball readonly constructor | string | Tarball URL (dist.tarball). | PackageVersion |
$version readonly constructor | string | Version string, exactly as keyed in the registry versions object. | PackageVersion |
Methods
Section titled “Methods”| Method | Description | Defined by |
|---|---|---|
__construct() | Describes one installable npm package version. | PackageVersion |
Method details
Section titled “Method details”__construct()
Section titled “__construct() ”public function __construct(string $name, string $version, string $tarball, string $integrity, array<array-key, string> $dependencies = [], array<array-key, string> $peerDependencies = [], array<array-key, string> $optionalDependencies = [], list<string> $optionalPeerDependencies = [], string|null $deprecated = null)Describes one installable npm package version.
Parameters
| Parameter | Type | Description |
|---|---|---|
$name | string | Package name. |
$version | string | Version string, exactly as keyed in the registry versions object. |
$tarball | string | Tarball URL (dist.tarball). |
$integrity | string | Subresource Integrity value: dist.integrity, or sha1-<base64> derived from dist.shasum. |
$dependencies | array<array-key, | Runtime dependencies keyed by package name. |
$peerDependencies | array<array-key, | Peer dependencies keyed by package name. |
$optionalDependencies | array<array-key, | Optional dependencies keyed by package name. |
$optionalPeerDependencies | list<string> | Peer names whose peerDependenciesMeta entry declares optional: true. |
$deprecated | string| | Deprecation text, or null when the version is not deprecated. |