UNPKG

is-path-cwd/index.d.ts

Version:

292 BTypeScriptView Raw

1/**
2Check if a path is the [current working directory](https://en.wikipedia.org/wiki/Working_directory).
3
4@example
5```
6import isPathCwd from 'is-path-cwd';
7
8isPathCwd(process.cwd());
9//=> true
10
11isPathCwd('unicorn');
12//=> false
13```
14*/
15export default function isPathCwd(path: string): boolean;

1	`/**`
2	`Check if a path is the [current working directory](https://en.wikipedia.org/wiki/Working_directory).`
3
4	`@example`
5	```
6	`import isPathCwd from 'is-path-cwd';`
7
8	`isPathCwd(process.cwd());`
9	`//=> true`
10
11	`isPathCwd('unicorn');`
12	`//=> false`
13	```
14	`*/`
15	`export default function isPathCwd(path: string): boolean;`