summaryrefslogtreecommitdiff
path: root/desktop/node_modules/junk/index.d.ts
diff options
context:
space:
mode:
authorRaindropsSys <raindrops@equestria.dev>2023-10-24 17:43:37 +0200
committerRaindropsSys <raindrops@equestria.dev>2023-10-24 17:43:37 +0200
commitae187b6d75c8079da0be1dc288613bad8466fe61 (patch)
tree5ea0d34185a2270f29ffaa65e1f5258028d7d5d0 /desktop/node_modules/junk/index.d.ts
downloadmist-ae187b6d75c8079da0be1dc288613bad8466fe61.tar.gz
mist-ae187b6d75c8079da0be1dc288613bad8466fe61.tar.bz2
mist-ae187b6d75c8079da0be1dc288613bad8466fe61.zip
Initial commit
Diffstat (limited to 'desktop/node_modules/junk/index.d.ts')
-rw-r--r--desktop/node_modules/junk/index.d.ts40
1 files changed, 40 insertions, 0 deletions
diff --git a/desktop/node_modules/junk/index.d.ts b/desktop/node_modules/junk/index.d.ts
new file mode 100644
index 0000000..46dbded
--- /dev/null
+++ b/desktop/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;