blob: 0db6d0fdf4615565396f0286e2af9b4a5adfc306 (
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
|
# @kwsites/file-exists
Synchronous validation of a path existing either as a file or as a directory.
```
const { exists, FILE, FOLDER, READABLE } = require('@kwsites/file-exists');
// check for a folder existing
assert(exists(__dirname, FOLDER));
assert(!exists(__filename, FOLDER));
// check for a file existing
assert(!exists(__filename, FILE));
assert(exists(__filename, FILE));
// when no type is specified, both folders and files are allowed
assert(exists(__dirname));
assert(exists(__filename));
// alternatively specify both files and folders
assert(exists(__dirname, FILE + FOLDER));
// or just that the path is readable (can be either a file or folder)
assert(exists(__filename, READABLE));
```
## Troubleshooting
This library uses [debug](https://www.npmjs.com/package/debug) to handle logging,
to enable logging, use either the environment variable:
```
"DEBUG=@kwsites/file-exists" node ./your-app.js
```
Or explicitly enable logging using the `debug` library itself:
```javascript
require('debug').enable('@kwsites/file-exists');
```
|
