github-pages-deploy-action/node_modules/read-pkg
2019-11-19 07:48:29 -05:00
..
index.js Dependencies 2019-11-19 07:48:29 -05:00
license Dependencies 2019-11-19 07:48:29 -05:00
package.json Dependencies 2019-11-19 07:48:29 -05:00
readme.md Dependencies 2019-11-19 07:48:29 -05:00

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