Package Exports
- readdir-clean
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (readdir-clean) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
readdir-clean
Like fs.readdir but excludes autogenerated contents for example .DS_Store and Thumbs.db
const {readdirSync} = require('fs');
const readdirClean = require('readdir-clean');
(async () => {
readdirSync('.');
/*=> [
'.DS_Store',
'.AppleDouble',
'.LSOverride',
'a.txt',
'b.txt',
'Thumbs.db'
] */
await readdirClean('.');
/*=> [
'a.txt',
'b.txt'
] */
})();Installation
npm install readdir-cleanAPI
const readdirClean = require('readdir-clean');readdirClean(path)
path: string, Buffer or URL (directory path)
Return: Promise<Array<string>>
Similar to Node.js built-in fs.readdir, but different in the following points:
- Returns a
Promise - Doesn't support
encodingoption - The paths are filtered with
require('junk').not
readdirClean('path/to/dir').then(paths => {
paths.includes('.Spotlight-V100'); //=> false
paths.includes('.Trashes'); //=> false
paths.includes('Desktop.ini'); //=> false
});License
ISC License © 2017 Shinnosuke Watanabe