Nary a Package Missing

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

    2.0.0 • Public • Published

    read-pkg Build Status

    Read a package.json file

    Why

    Install

    $ npm install --save read-pkg
    

    Usage

    const readPkg = require('read-pkg');
    
    readPkg().then(pkg => {
    	console.log(pkg);
    	//=> {name: 'read-pkg', ...}
    });
    
    readPkg(__dirname).then(pkg => {
    	console.log(pkg);
    	//=> {name: 'read-pkg', ...}
    });
    
    readPkg(path.join('unicorn', 'package.json')).then(pkg => {
    	console.log(pkg);
    	//=> {name: 'read-pkg', ...}
    });

    API

    readPkg([path], [options])

    Returns a Promise for the parsed JSON.

    readPkg.sync([path], [options])

    Returns the parsed JSON.

    path

    Type: string
    Default: .

    Path to a package.json file or its directory.

    options

    normalize

    Type: boolean
    Default: true

    Normalize the package data.

    Related

    License

    MIT © Sindre Sorhus

    Install

    npm i read-pkg@2.0.0

    Version

    2.0.0

    License

    MIT

    Last publish

    Collaborators

    • sindresorhus