diff options
| author | Shipwreckt <me@shipwreckt.co.uk> | 2025-10-31 20:02:14 +0000 |
|---|---|---|
| committer | Shipwreckt <me@shipwreckt.co.uk> | 2025-10-31 20:02:14 +0000 |
| commit | 7a52ddeba2a68388b544f529d2d92104420f77b0 (patch) | |
| tree | 15ddd47457a2cb4a96060747437d36474e4f6b4e /node_modules/junk/index.d.ts | |
| parent | 53d6ae2b5568437afa5e4995580a3fb679b7b91b (diff) | |
Changed from static to 11ty!
Diffstat (limited to 'node_modules/junk/index.d.ts')
| -rw-r--r-- | node_modules/junk/index.d.ts | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/node_modules/junk/index.d.ts b/node_modules/junk/index.d.ts new file mode 100644 index 0000000..46dbded --- /dev/null +++ b/node_modules/junk/index.d.ts @@ -0,0 +1,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; |
