npm Registry API Client
    Preparing search index...

    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>;
    }
    Index

    Properties

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

    Properties

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

    Bug tracker

    description?: string

    Short description

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

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

    homepage?: string

    Homepage URL

    keywords?: string[]

    Keywords for search

    license?: string

    SPDX license identifier or expression

    maintainers?: NpmPerson[]

    Current maintainers

    name: string

    Package name

    readme?: string

    README content

    readmeFilename?: string

    Filename of the README

    repository?: NpmRepository

    Source repository

    time: Record<string, string>

    Timestamps: created, modified, and one entry per version

    versions: Record<string, NpmPackageVersion>

    Map of version strings to their full version manifests

    Settings

    Member Visibility

    On This Page

    Properties