file-set

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.

Usage

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/*' ]
}

API

file-set

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

FileSet ⏏

Kind: Exported class

new FileSet()

fileSet.files : `Array.<string>`

The existing files found

Kind: instance property of FileSet

fileSet.dirs : `Array.<string>`

The existing directories found. Directory paths will always end with '/'.

Kind: instance property of FileSet

fileSet.notExisting : `Array.<string>`

Paths which were not found

Kind: instance property of FileSet

fileSet.add(patterns)

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.

Tested by test-runner.

Current Tags

5.1.3 ... latest (3 years ago)
1.1.2 ... prev (6 years ago)

file-set

Usage

API

file-set

FileSet ⏏

new FileSet()

fileSet.files : Array.<string>

fileSet.dirs : Array.<string>

fileSet.notExisting : Array.<string>

fileSet.add(patterns)

Current Tags

31 Versions

fileSet.files : `Array.<string>`

fileSet.dirs : `Array.<string>`

fileSet.notExisting : `Array.<string>`