c29b520108 | ||
---|---|---|
.. | ||
LICENSE | ||
README.hbs | ||
README.md | ||
index.js | ||
package.json |
README.md
file-set
Breaks an input list of file paths and glob expressions into three categories: files, directories and not existing.
Example
const FileSet = require('file-set')
Install
$ npm install file-set
Usage
> const FileSet = require('file-set');
> new FileSet([ '*', 'not/existing/*' ])
FileSet {
files: [ 'LICENSE', 'package.json', 'README.md' ],
dirs: [ 'jsdoc2md/', 'lib/', 'node_modules/', 'test/' ],
notExisting: [ 'not/existing/*' ] }
API
Breaks an input list of file paths and glob expressions into three categories: files, directories and not existing.
Example
const FileSet = require('file-set')
- file-set
- FileSet ⏏
- new FileSet(patternList)
- .files :
Array.<string>
- .dirs :
Array.<string>
- .notExisting :
Array.<string>
- .add(files)
- FileSet ⏏
FileSet ⏏
new FileSet(patternList)
Param | Type | Description |
---|---|---|
patternList | string | Array.<string> |
One or more file paths or glob expressions to inspect. |
fileSet.files : Array.<string>
The existing files found
Kind: instance property of FileSet
fileSet.dirs : Array.<string>
The existing directories found
Kind: instance property of FileSet
fileSet.notExisting : Array.<string>
Paths which were not found
Kind: instance property of FileSet
fileSet.add(files)
Add file patterns to the set.
Kind: instance method of FileSet
Param | Type | Description |
---|---|---|
files | string | Array.<string> |
One or more file paths or glob expressions to inspect. |
© 2014-19 Lloyd Brookes <75pound@gmail.com>. Documented by jsdoc-to-markdown.