index.d.ts
914 Bytes
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
declare namespace pkgUp {
interface Options {
/**
Directory to start from.
@default process.cwd()
*/
readonly cwd?: string;
}
}
declare const pkgUp: {
/**
Find the closest `package.json` file.
@returns The filepath, or `null` if it couldn't be found.
@example
```
// /
// └── Users
// └── sindresorhus
// └── foo
// ├── package.json
// └── bar
// ├── baz
// └── example.js
// example.js
import pkgUp = require('pkg-up');
(async () => {
console.log(await pkgUp());
//=> '/Users/sindresorhus/foo/package.json'
})();
```
*/
(options?: pkgUp.Options): Promise<string | null>;
/**
Synchronously find the closest `package.json` file.
@returns The filepath, or `null` if it couldn't be found.
*/
sync(options?: pkgUp.Options): string | null;
};
export = pkgUp;