blob: 46dbded6ea2467747658ef525e9174075c95af65 (
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
|
declare const junk: {
/**
Returns `true` if `filename` matches a junk file.
*/
is(filename: string): boolean;
/**
Returns `true` if `filename` doesn't match a junk file.
@example
```
import {promisify} from 'util';
import * as fs from 'fs';
import junk = require('junk');
const pReaddir = promisify(fs.readdir);
(async () => {
const files = await pReaddir('some/path');
console.log(files);
//=> ['.DS_Store', 'test.jpg']
console.log(files.filter(junk.not));
//=> ['test.jpg']
})();
```
*/
not(filename: string): boolean;
/**
Regex used for matching junk files.
*/
readonly regex: RegExp;
// TODO: Remove this for the next major release
default: typeof junk;
};
export = junk;
|
