-
-
Notifications
You must be signed in to change notification settings - Fork 14
/
index.d.ts
59 lines (47 loc) · 1.21 KB
/
index.d.ts
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
export type Options = {
/**
The directory to start from.
@default process.cwd()
*/
readonly cwd?: string;
};
/**
Find the closest `package.json` file.
@returns The file path, or `undefined` if it could not be found.
@example
```
// /
// └── Users
// └── sindresorhus
// └── foo
// ├── package.json
// └── bar
// ├── baz
// └── example.js
// example.js
import {packageUp} from 'package-up';
console.log(await packageUp());
//=> '/Users/sindresorhus/foo/package.json'
```
*/
export function packageUp(options?: Options): Promise<string | undefined>;
/**
Synchronously find the closest `package.json` file.
@returns The file path, or `undefined` if it could not be found.
@example
```
// /
// └── Users
// └── sindresorhus
// └── foo
// ├── package.json
// └── bar
// ├── baz
// └── example.js
// example.js
import {packageUpSync} from 'package-up';
console.log(packageUpSync());
//=> '/Users/sindresorhus/foo/package.json'
```
*/
export function packageUpSync(options?: Options): string | undefined;