Expands a list of paths and glob expressions into three sets: "files", "directories" and "not existing". Each set in the output is a list of unique paths.
The library saves you the job of learning a globbing library, expanding a glob expression (e.g. lib/**/*
), sifting through each result testing whether it's a file, directory or neither.
Expand two glob expressions ('*'
and 'not/existing/*'
).
import FileSet from 'file-set'
const fileSet = new FileSet()
await fileSet.add([ '*', 'not/existing/*' ])
console.log(fileSet)
The output has been organised into sets.
FileSet {
files: [ 'LICENSE', 'package.json', 'README.md' ],
dirs: [ 'jsdoc2md/', 'lib/', 'node_modules/', 'test/' ],
notExisting: [ 'not/existing/*' ]
}
- file-set
- FileSet ⏏
- new FileSet()
- .files :
Array.<string>
- .dirs :
Array.<string>
- .notExisting :
Array.<string>
- .add(files)
- FileSet ⏏
The existing files found
Kind: instance property of FileSet
The existing directories found. Directory paths will always end with '/'
.
Kind: instance property of FileSet
Paths which were not found
Kind: instance property of FileSet
Add file patterns to the set.
Kind: instance method of FileSet
Param | Type | Description |
---|---|---|
patterns | string | Array.<string> |
One or more file paths or glob expressions to inspect. |
© 2014-22 Lloyd Brookes <75pound@gmail.com>.
Tested by test-runner.