Interface NpmPackageVersion

Version manifest returned by GET /:package/:version.

Represents the metadata for a single published version of a package.

interface NpmPackageVersion {
    _id?: string;
    _nodeVersion?: string;
    _npmVersion?: string;
    bugs?: { email?: string; url?: string };
    bundledDependencies?: string[];
    dependencies?: Record<string, string>;
    deprecated?: string;
    description?: string;
    devDependencies?: Record<string, string>;
    dist: NpmDist;
    engines?: Record<string, string>;
    homepage?: string;
    keywords?: string[];
    license?: string;
    main?: string;
    maintainers?: NpmPerson[];
    name: string;
    optionalDependencies?: Record<string, string>;
    peerDependencies?: Record<string, string>;
    repository?: NpmRepository;
    scripts?: Record<string, string>;
    version: string;
}

Properties

_id? _nodeVersion? _npmVersion? bugs? bundledDependencies? dependencies? deprecated? description? devDependencies? dist engines? homepage? keywords? license? main? maintainers? name optionalDependencies? peerDependencies? repository? scripts? version

Properties

Optional_id

_id?: string

npm internal document ID (name@version)

Optional_nodeVersion

_nodeVersion?: string

Node.js version used to publish

Optional_npmVersion

_npmVersion?: string

npm CLI version used to publish

Optionalbugs

bugs?: { email?: string; url?: string }

Bug tracker

OptionalbundledDependencies

bundledDependencies?: string[]

Bundled dependencies

Optionaldependencies

dependencies?: Record<string, string>

Runtime dependencies

Optionaldeprecated

deprecated?: string

Deprecated notice (if version is deprecated)

Optionaldescription

description?: string

Short description

OptionaldevDependencies

devDependencies?: Record<string, string>

Development dependencies

dist

dist: NpmDist

Distribution tarball info

Optionalengines

engines?: Record<string, string>

Engines field (e.g. { node: '>=14' })

Optionalhomepage

homepage?: string

Homepage URL

Optionalkeywords

keywords?: string[]

Keywords for search

Optionallicense

license?: string

SPDX license identifier or expression

Optionalmain

main?: string

Entry point for CommonJS consumers

Optionalmaintainers

maintainers?: NpmPerson[]

Current maintainers

name

name: string

Package name

OptionaloptionalDependencies

optionalDependencies?: Record<string, string>

Optional dependencies

OptionalpeerDependencies

peerDependencies?: Record<string, string>

Peer dependencies

Optionalrepository

repository?: NpmRepository

Source repository

Optionalscripts

scripts?: Record<string, string>

Scripts defined in the package

version

version: string

Version string (semver)

Settings

Member Visibility

On This Page

Properties