mirror of
https://github.com/fooflington/selfdefined.git
synced 2025-12-19 10:12:51 +00:00
update
This commit is contained in:
46
node_modules/junk/readme.md
generated
vendored
Normal file
46
node_modules/junk/readme.md
generated
vendored
Normal file
@@ -0,0 +1,46 @@
|
||||
# junk [](https://travis-ci.org/sindresorhus/junk)
|
||||
|
||||
> Filter out [OS junk files](test.js) like `.DS_Store` and `Thumbs.db`
|
||||
|
||||
|
||||
## Install
|
||||
|
||||
```sh
|
||||
$ npm install --save junk
|
||||
```
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
var fs = require('fs');
|
||||
var junk = require('junk');
|
||||
|
||||
fs.readdir('path', function (err, files) {
|
||||
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.re
|
||||
|
||||
The regex used for matching.
|
||||
|
||||
|
||||
## License
|
||||
|
||||
MIT © [Sindre Sorhus](http://sindresorhus.com)
|
||||
Reference in New Issue
Block a user