Adam Rensel b05888e79d Add the correct demo app 10 years ago
..
index.js b05888e79d Add the correct demo app 10 years ago
package.json b05888e79d Add the correct demo app 10 years ago
readme.md 0ad841a423 init commit 10 years ago

readme.md

junk Build Status

Filter out OS junk files like .DS_Store and Thumbs.db

Install

$ npm install --save junk

Usage

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