summaryrefslogtreecommitdiff
path: root/node_modules/junk/readme.md
diff options
context:
space:
mode:
authorLinuxWizard42 <computerwizard@linuxmail.org>2022-10-12 22:54:37 +0300
committerLinuxWizard42 <computerwizard@linuxmail.org>2022-10-12 22:54:37 +0300
commit703e03aba33f234712206769f57717ba7d92d23d (patch)
tree0041f04ccb75bd5379c764e9fe42249fffe75fc3 /node_modules/junk/readme.md
parentab6e257e6e9d9a483d7e86f220d8b209a2cd7753 (diff)
downloadFlashRunner-703e03aba33f234712206769f57717ba7d92d23d.tar.gz
FlashRunner-703e03aba33f234712206769f57717ba7d92d23d.tar.zst
Added export_allowed file to make repository visible in cgit
Diffstat (limited to 'node_modules/junk/readme.md')
-rw-r--r--node_modules/junk/readme.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/node_modules/junk/readme.md b/node_modules/junk/readme.md
new file mode 100644
index 0000000..74c23ca
--- /dev/null
+++ b/node_modules/junk/readme.md
@@ -0,0 +1,51 @@
+# junk [![Build Status](https://travis-ci.org/sindresorhus/junk.svg?branch=master)](https://travis-ci.org/sindresorhus/junk)
+
+> Filter out [system junk files](test.js) like `.DS_Store` and `Thumbs.db`
+
+
+## Install
+
+```
+$ npm install junk
+```
+
+
+## Usage
+
+```js
+const {promisify} = require('util');
+const fs = require('fs');
+const 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']
+})();
+```
+
+
+## API
+
+### junk.is(filename)
+
+Returns `true` if `filename` matches a junk file.
+
+### junk.not(filename)
+
+Returns `true` if `filename` doesn't match a junk file.
+
+### junk.regex
+
+Regex used for matching junk files.
+
+
+## License
+
+MIT © [Sindre Sorhus](https://sindresorhus.com)