Interface NpmPackument

Full package document (packument) returned by GET /:package.

Contains metadata for all published versions of a package.

interface NpmPackument {
    bugs?: { email?: string; url?: string };
    description?: string;
    "dist-tags": Record<string, string>;
    homepage?: string;
    keywords?: string[];
    license?: string;
    maintainers?: NpmPerson[];
    name: string;
    readme?: string;
    readmeFilename?: string;
    repository?: NpmRepository;
    time: Record<string, string>;
    versions: Record<string, NpmPackageVersion>;
}

Properties

bugs? description? dist-tags homepage? keywords? license? maintainers? name readme? readmeFilename? repository? time versions

Properties

Optionalbugs

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

Bug tracker

Optionaldescription

description?: string

Short description

dist-tags

"dist-tags": Record<string, string>

Map of dist-tags (e.g. { latest: '1.2.3' })

Optionalhomepage

homepage?: string

Homepage URL

Optionalkeywords

keywords?: string[]

Keywords for search

Optionallicense

license?: string

SPDX license identifier or expression

Optionalmaintainers

maintainers?: NpmPerson[]

Current maintainers

name

name: string

Package name

Optionalreadme

readme?: string

README content

OptionalreadmeFilename

readmeFilename?: string

Filename of the README

Optionalrepository

repository?: NpmRepository

Source repository

time

time: Record<string, string>

Timestamps: created, modified, and one entry per version

versions

versions: Record<string, NpmPackageVersion>

Map of version strings to their full version manifests

Settings

Member Visibility

On This Page

Properties