setup-python/node_modules/read-pkg/readme.md
Danny McCormick 39c08a0eaa Initial pass
2019-06-26 21:12:00 -04:00

1.5 KiB

read-pkg Build Status

Read a package.json file

Why

Install

$ npm install read-pkg

Usage

const readPkg = require('read-pkg');

(async () => {
	console.log(await readPkg());
	//=> {name: 'read-pkg', …}

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

API

readPkg([options])

Returns a Promise<object> with the parsed JSON.

readPkg.sync([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.

License

MIT © Sindre Sorhus