This repository has been archived on 2020-11-02. You can view files and clone it, but cannot push or open issues or pull requests.
TripSit_Suite/node_modules/read-pkg/readme.md
2020-11-01 22:46:04 +00:00

1.6 KiB

read-pkg Build Status

Read a package.json file

Why

Install

$ npm install 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: process.cwd()

Path to a package.json file or its directory.

options

normalize

Type: boolean
Default: true

Normalize the package data.

License

MIT © Sindre Sorhus