Have ideas to improve npm?Join in the discussion! »

    package-json
    TypeScript icon, indicating that this package has built-in type declarations

    6.5.0 • Public • Published

    package-json Build Status

    Get metadata of a package from the npm registry

    Install

    $ npm install package-json
    

    Usage

    const packageJson = require('package-json');
     
    (async () => {
        console.log(await packageJson('ava'));
        //=> {name: 'ava', ...}
     
        // Also works with scoped packages
        console.log(await packageJson('@sindresorhus/df'));
    })();

    API

    packageJson(packageName, options?)

    packageName

    Type: string

    Name of the package.

    options

    Type: object

    version

    Type: string
    Default: latest

    Package version such as 1.0.0 or a dist tag such as latest.

    The version can also be in any format supported by the semver module. For example:

    • 1 - Get the latest 1.x.x
    • 1.2 - Get the latest 1.2.x
    • ^1.2.3 - Get the latest 1.x.x but at least 1.2.3
    • ~1.2.3 - Get the latest 1.2.x but at least 1.2.3
    fullMetadata

    Type: boolean
    Default: false

    By default, only an abbreviated metadata object is returned for performance reasons. Read more.

    allVersions

    Type: boolean
    Default: false

    Return the main entry containing all versions.

    registryUrl

    Type: string
    Default: Auto-detected

    The registry URL is by default inferred from the npm defaults and .npmrc. This is beneficial as package-json and any project using it will work just like npm. This option is only intended for internal tools. You should not use this option in reusable packages. Prefer just using .npmrc whenever possible.

    agent

    Type: http.Agent | https.Agent | object | false

    Overwrite the agent option that is passed down to got. This might be useful to add proxy support.

    packageJson.PackageNotFoundError

    The error thrown when the given package name cannot be found.

    packageJson.VersionNotFoundError

    The error thrown when the given package version cannot be found.

    Authentication

    Both public and private registries are supported, for both scoped and unscoped packages, as long as the registry uses either bearer tokens or basic authentication.

    Related


    Get professional support for this package with a Tidelift subscription
    Tidelift helps make open source sustainable for maintainers while giving companies
    assurances about security, maintenance, and licensing for their dependencies.

    Install

    npm i package-json

    DownloadsWeekly Downloads

    8,571,308

    Version

    6.5.0

    License

    MIT

    Unpacked Size

    14.3 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar
    • avatar