bigint-crypto-utils/node_modules/jsdoc-api/node_modules/file-set

file-set

Exports a contructor taking a list of file patterns as input, returning a file-set instance containing the expanded patterns split into separate lists of files, dirs and notExisting.

Example

const FileSet = require('file-set')

Install

$ npm install file-set --save

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

Exports a contructor taking a list of file patterns as input, returning a file-set instance containing the expanded patterns split into separate lists of files, dirs and notExisting.

Example

const FileSet = require('file-set')

• file-set
  • FileSet ⏏
    • new FileSet(patternList)
    • .files : Array.<string>
    • .dirs : Array.<string>
    • .notExisting : Array.<string>
    • .add(files)

FileSet ⏏

Expands file patterns, returning the matched and unmatched files and directories

Kind: Exported class

new FileSet(patternList)

Param	Type	Description
patternList	string | Array.<string>	A pattern, or array of patterns to expand

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>	A pattern, or array of patterns to expand

---

© 2014-18 Lloyd Brookes <75pound@gmail.com>. Documented by jsdoc-to-markdown.