Sha256: f55e1fb06c082b367a0f2c0f54422c78980a72607dae2ea8e919f633e449c8ae
Contents?: true
Size: 745 Bytes
Versions: 69
Compression:
Stored size: 745 Bytes
Contents
# 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)
Version data entries
69 entries across 69 versions & 2 rubygems