This package has been deprecated

Author message:

Renamed to read-package-up

read-pkg-up
TypeScript icon, indicating that this package has built-in type declarations

11.0.0 • Public • Published

read-pkg-up

Read the closest package.json file

Why

Install

npm install read-pkg-up

Usage

import {readPackageUp} from 'read-pkg-up';

console.log(await readPackageUp());
/*
{
	packageJson: {
		name: 'awesome-package',
		version: '1.0.0',

	},
	path: '/Users/sindresorhus/dev/awesome-package/package.json'
}
*/

API

readPackageUp(options?)

Returns a Promise<object>, or Promise<undefined> if no package.json was found.

readPackageUpSync(options?)

Returns the result object, or undefined if no package.json was found.

options

Type: object

cwd

Type: URL | string
Default: process.cwd()

The directory to start looking for a package.json file.

normalize

Type: boolean
Default: true

Normalize the package data.

  • read-pkg - Read a package.json file
  • pkg-up - Find the closest package.json file
  • find-up - Find a file by walking up parent directories
  • pkg-conf - Get namespaced config from the closest package.json

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Published

Version History

  • Version
    Downloads (Last 7 Days)
    • Published
  • 10.1.0
    518,919
  • 10.0.0
    233,860
  • 9.1.0
    443,347
  • 9.0.0
    398
  • 8.0.0
    1,573,612
  • 7.0.1
    16,370,419
  • 7.0.0
    4,383
  • 6.0.0
    56,928
  • 5.0.0
    240,790
  • 4.0.0
    1,943,560
  • 3.0.0
    3,465,003
  • 2.0.0
    2,433,490
  • 1.0.1
    5,283,547

Package Sidebar

Install

npm i read-pkg-up

Weekly Downloads

33,059,528

Version

11.0.0

License

MIT

Unpacked Size

6.23 kB

Total Files

5

Last publish

Collaborators

  • sindresorhus