read-pkg
Advanced tools
- Version published
- Maintainers
- 1
- Weekly downloads
- 38,182,902
- increased by6.03%
Weekly downloads
Readme
read-pkg
Read a package.json file
Why
Install
npm install read-pkg
Usage
import {readPackage} from 'read-pkg';
console.log(await readPackage());
//=> {name: 'read-pkg', …}
console.log(await readPackage({cwd: 'some-other-directory'}));
//=> {name: 'unicorn', …}
API
readPackage(options?)
Returns a Promise<object> with the parsed JSON.
readPackageSync(options?)
Returns the parsed JSON.
options
Type: object
cwd
Type: URL | string
Default: process.cwd()
Current working directory.
normalize
Type: boolean
Default: true
Normalize the package data.
parsePackage(packageFile, options?)
Parses an object or string into JSON.
Note: packageFile is cloned using structuredClone to prevent modification to the input object. This function is available from Node.js 18 on. In environments without structuredClone (such as Node.js 16), a shallow spread is used instead, which can cause deep properties of the object to be modified. Consider cloning the object before using parsePackage if that's the case.
packageFile
Type: object | string\
An object or a stringified object to be parsed as a package.json.
options
Type: object
normalize
Type: boolean
Default: true
Normalize the package data.
Related
- read-pkg-up - Read the closest package.json file
- write-pkg - Write a
package.jsonfile - load-json-file - Read and parse a JSON file
FAQs
Read a package.json file
The npm package read-pkg receives a total of 31,022,320 weekly downloads. As such, read-pkg popularity was classified as popular.
We found that read-pkg demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.