UNPKG

path-type

Version:

Check if a path is a file, directory, or symlink

github.com/sindresorhus/path-type

sindresorhus/path-type

63 lines (34 loc) • 890 B
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
# path-type > Check if a path is a file, directory, or symlink ## Install ```sh npm install path-type ``` ## Usage ```js import {isFile} from 'path-type'; console.log(await isFile('package.json')); //=> true ``` ## API ### isFile(path) Check whether the passed `path` is a file. Returns a `Promise<boolean>`. #### path Type: `string` The path to check. ### isDirectory(path) Check whether the passed `path` is a directory. Returns a `Promise<boolean>`. ### isSymlink(path) Check whether the passed `path` is a symlink. Returns a `Promise<boolean>`. ### isFileSync(path) Synchronously check whether the passed `path` is a file. Returns a `boolean`. ### isDirectorySync(path) Synchronously check whether the passed `path` is a directory. Returns a `boolean`. ### isSymlinkSync(path) Synchronously check whether the passed `path` is a symlink. Returns a `boolean`.