legendary-doc-site/apps/core/assets/node_modules/junk
2020-07-03 21:41:01 -05:00
..
index.d.ts chore: Convert to umbrella app 2020-07-03 21:41:01 -05:00
index.js chore: Convert to umbrella app 2020-07-03 21:41:01 -05:00
license chore: Convert to umbrella app 2020-07-03 21:41:01 -05:00
package.json chore: Convert to umbrella app 2020-07-03 21:41:01 -05:00
readme.md chore: Convert to umbrella app 2020-07-03 21:41:01 -05:00

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