Class PackageResource

Represents an npm package resource, providing access to package metadata, versions, dist-tags, and download statistics.

Implements PromiseLike<NpmPackument> so it can be awaited directly to fetch the full packument, while also exposing sub-resource methods.

Example

// Await directly to get full package metadata
const pkg = await npm.package('react');

// Get a specific version
const v18 = await npm.package('react').version('18.2.0');

// Get dist-tags
const tags = await npm.package('react').distTags();

// Get download stats for last month
const stats = await npm.package('react').downloads();

// Get daily download breakdown for a custom date range
const range = await npm.package('react').downloadRange('2024-01-01:2024-01-31');

Implements

Methods

distTags downloadRange downloads get latest maintainers then version versions

Methods

distTags

  • distTags(signal?: AbortSignal): Promise<NpmDistTags>

    Fetches all dist-tags for this package.

    GET /-/package/{name}/dist-tags

    Parameters

    • Optionalsignal: AbortSignal

      Optional AbortSignal to cancel the request

    Returns Promise<NpmDistTags>

    A map of tag names to version strings

    Example

    const tags = await npm.package('react').distTags();
    // { latest: '18.2.0', next: '19.0.0-beta.1' }

downloadRange

  • downloadRange(
        period?: NpmDownloadPeriod,
        signal?: AbortSignal,
    ): Promise<NpmDownloadRange>

    Fetches the per-day download breakdown for this package over a given period.

    GET /downloads/range/{period}/{name} (via api.npmjs.org)

    Parameters

    • period: NpmDownloadPeriod = 'last-month'

      Named period or date range (default: 'last-month')

    • Optionalsignal: AbortSignal

      Optional AbortSignal to cancel the request

    Returns Promise<NpmDownloadRange>

    Download range data with a per-day array

    Example

    const range = await npm.package('react').downloadRange('2024-01-01:2024-01-31');
    range.downloads.forEach(d => console.log(d.day, d.downloads));

downloads

  • downloads(
        period?: NpmDownloadPeriod,
        signal?: AbortSignal,
    ): Promise<NpmDownloadPoint>

    Fetches the total download count for this package over a given period.

    GET /downloads/point/{period}/{name} (via api.npmjs.org)

    Parameters

    • period: NpmDownloadPeriod = 'last-month'

      Named period or date range (default: 'last-month')

    • Optionalsignal: AbortSignal

      Optional AbortSignal to cancel the request

    Returns Promise<NpmDownloadPoint>

    Download point data including total count and date range

    Example

    const stats = await npm.package('react').downloads('last-week');
    console.log(stats.downloads); // 12345678

get

  • get(signal?: AbortSignal): Promise<NpmPackument>

    Fetches the full packument (all versions metadata) for this package.

    GET /{name}

    Parameters

    • Optionalsignal: AbortSignal

      Optional AbortSignal to cancel the request

    Returns Promise<NpmPackument>

    The full packument object

latest

maintainers

  • maintainers(signal?: AbortSignal): Promise<NpmPerson[]>

    Fetches the current maintainers of this package.

    Internally fetches the packument and returns the maintainers array.

    GET /{name}

    Parameters

    • Optionalsignal: AbortSignal

      Optional AbortSignal to cancel the request

    Returns Promise<NpmPerson[]>

    Array of maintainer entries (name, email, url)

    Example

    const maintainers = await npm.package('typescript').maintainers();
    maintainers.forEach(m => console.log(m.name, m.email));

then

version

versions

  • versions(signal?: AbortSignal): Promise<NpmPackageVersion[]>

    Fetches all published versions of this package as an ordered array.

    Internally fetches the packument and converts the versions map to an array sorted from oldest to newest.

    GET /{name}

    Parameters

    • Optionalsignal: AbortSignal

      Optional AbortSignal to cancel the request

    Returns Promise<NpmPackageVersion[]>

    Array of version manifests sorted by publication order

    Example

    const versions = await npm.package('typescript').versions();
    console.log(versions.map(v => v.version).join(', '));

Settings

Member Visibility

On This Page

Methods