Package Exports
- read-pkg
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (read-pkg) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
read-pkg 
Read a
package.jsonfile
Why
- Strips UTF-8 BOM.
- Gracefully handles filesystem issues.
- Throws more helpful JSON errors.
- Normalizes the data.
Install
$ npm install --save read-pkgUsage
var readPkg = require('read-pkg');
readPkg().then(function (pkg) {
console.log(pkg);
//=> {name: 'read-pkg', ...}
});
readPkg(__dirname).then(function (pkg) {
console.log(pkg);
//=> {name: 'read-pkg', ...}
});
readPkg(path.join('unicorn', 'package.json')).then(function (pkg) {
console.log(pkg);
//=> {name: 'read-pkg', ...}
});API
readPkg([path], [options])
Returns a promise that resolves to 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
- write-pkg - Write a
package.jsonfile - load-json-file - Read and parse a JSON file
License
MIT © Sindre Sorhus