JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 46322960
  • Score
    100M100P100Q233204F
  • License MIT

Read a package.json file

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 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 for 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