tree: 2b5a76fe22de095364ac7c599f40cf6971d72cc4 [path history] [tgz]
  1. index.d.ts
  2. index.js
  3. license
  4. package.json
  5. readme.md
node_modules/junk/readme.md

junk Build Status

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

Install

$ npm install junk

Usage

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