Newton's Preposterous Miscalculation
    Wondering what’s next for npm?Check out our public roadmap! »

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

    6.0.0 • Public • Published

    read-pkg

    Read a package.json file

    Why

    Install

    $ npm install read-pkg
    

    Usage

    import {readPackageAsync} from 'read-pkg';
    
    console.log(await readPkg());
    //=> {name: 'read-pkg', …}
    
    console.log(await readPkg({cwd: 'some-other-directory'}));
    //=> {name: 'unicorn', …}

    API

    readPackageAsync(options?)

    Returns a Promise<object> with the parsed JSON.

    readPackageSync(options?)

    Returns the parsed JSON.

    options

    Type: object

    cwd

    Type: string
    Default: process.cwd()

    Current working directory.

    normalize

    Type: boolean
    Default: true

    Normalize the package data.

    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 read-pkg

    DownloadsWeekly Downloads

    39,331,556

    Version

    6.0.0

    License

    MIT

    Unpacked Size

    5.77 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar