aboutsummaryrefslogtreecommitdiff
path: root/node_modules/find-cache-dir/node_modules/pkg-dir/readme.md
blob: 82bb8351780601f2531fb30ca3b0f1f9d1bac41b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# pkg-dir [![Build Status](https://travis-ci.org/sindresorhus/pkg-dir.svg?branch=master)](https://travis-ci.org/sindresorhus/pkg-dir)

> Find the root directory of a npm package


## Install

```
$ npm install --save pkg-dir
```


## Usage

```
/
└── Users
    └── sindresorhus
        └── foo
            ├── package.json
            └── bar
                ├── baz
                └── example.js
```

```js
// example.js
var pkgDir = require('pkg-dir');

pkgDir(__dirname).then(function (rootPath) {
	console.log(rootPath);
	//=> '/Users/sindresorhus/foo'
});
```


## API

### pkgDir([cwd])

Returns a promise that resolves to the package root path or `null`.

### pkgDir.sync([cwd])

Returns the package root path or `null`.

#### cwd

Type: `string`  
Default: `process.cwd()`

Directory to start from.


## Related

- [pkg-dir-cli](https://github.com/sindresorhus/pkg-dir-cli) - CLI for this module
- [find-up](https://github.com/sindresorhus/find-up) - Find a file by walking up parent directories


## License

MIT © [Sindre Sorhus](http://sindresorhus.com)