Read a package.json file


Keywords
json, read, parse, file, fs, graceful, load, package, normalize
License
MIT
Install
npm install read-pkg@5.1.1

Documentation

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.

Related

License

MIT © Sindre Sorhus