# load-pkg
> Loads package.json, by finding the first directory with a package.json, recursing up, starting with the given directory.
Latest version **4.0.0** (published 2018-06-27) · MIT license · 0 weekly downloads
## Install
```sh
npm install load-pkg
pnpm add load-pkg
yarn add load-pkg
bun add load-pkg
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 4.0.0 |
| Published | 2018-06-27 |
| First published | 2014-05-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 1 |
| Unpacked size | 8.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | config, dir, directory, file, find, find-up, findup, findup-sync, folder, json, load, look, look-up, match, package, package-json, parent, parents, parse, path, pkg, read, resolve, search, up, walk, walking |
## Links
- npm: https://www.npmjs.com/package/load-pkg
- Repository: https://github.com/jonschlinkert/load-pkg
- Issues: https://github.com/jonschlinkert/load-pkg/issues
- npm.io page: https://npm.io/package/load-pkg
## Dependencies (1)
- [find-pkg](https://npm.io/package/find-pkg.md) ^2.0.0
## Alternatives
- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads
## Recent versions
- 4.0.0 (latest) — 2018-06-27
- 3.0.1 — 2015-12-13
- 3.0.0 — 2015-11-28
- 2.0.1 — 2015-10-20
- 2.0.0 — 2015-10-20
- 1.3.0 — 2015-07-20
- 1.2.0 — 2015-04-07
- 1.1.3 — 2015-03-18
- 1.1.2 — 2015-03-03
- 1.1.1 — 2015-03-03
- 1.1.0 — 2015-03-03
- 1.0.0 — 2014-12-30
- 0.2.0 — 2014-12-01
- 0.1.0 — 2014-05-02
## README
# load-pkg [](https://www.npmjs.com/package/load-pkg) [](https://npmjs.org/package/load-pkg) [](https://npmjs.org/package/load-pkg) [](https://travis-ci.org/jonschlinkert/load-pkg)
> Loads package.json, by finding the first directory with a package.json, recursing up, starting with the given directory.
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save load-pkg
```
## Usage
### async
By default, if no callback is passed a promise is returned.
The following examples assume the code is inside an `async` function:
```js
const load = require('load-pkg');
// get the package.json from the cwd
const pkg = await load();
// specify the starting directory to search from
const pkg = await load('foo/bar');
```
### async callback
```js
const load = require('load-pkg');
// get the package.json from the cwd
load((err, pkg) => {
console.log(pkg);
});
// specify the starting directory to search from
load('foo/bar', (err, pkg) => {
console.log(pkg);
});
```
### sync
Loads the package.json in `process.cwd()` by default:
```js
const load = require('load-pkg');
// the following are equivalent
const pkg = load.sync(process.cwd());
const pkg = load.sync();
```
Specify a cwd or filepath to start from:
```js
const pkg = require('load-pkg').sync('a/b/c');
```
## Release history
### v3.0.0
* The main export now returns a promise if no callback is passed. There should not be any breaking changes.
### v2.0.0
**Breaking changes**
* The main export is now a function that must be called.
## About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Related projects
You might also be interested in these projects:
* [cwd](https://www.npmjs.com/package/cwd): Easily get the CWD (current working directory) of a project based on package.json, optionally starting… [more](https://github.com/jonschlinkert/cwd) | [homepage](https://github.com/jonschlinkert/cwd "Easily get the CWD (current working directory) of a project based on package.json, optionally starting from a given path. (node.js/javascript util)")
* [find-pkg](https://www.npmjs.com/package/find-pkg): Find the first directory with a package.json, recursing up, starting with the given directory. Similar… [more](https://github.com/jonschlinkert/find-pkg) | [homepage](https://github.com/jonschlinkert/find-pkg "Find the first directory with a package.json, recursing up, starting with the given directory. Similar to look-up but does not support globs and only searches for package.json. Async and sync.")
* [look-up](https://www.npmjs.com/package/look-up): Faster drop-in replacement for find-up and findup-sync. | [homepage](https://github.com/jonschlinkert/look-up "Faster drop-in replacement for find-up and findup-sync.")
### Author
**Jon Schlinkert**
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)
### License
Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on June 27, 2018._
---
_Source: https://npm.io/package/load-pkg · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._