silex-glob

0.1.5 • Public • Published

Glob (SilexJS)

Simple globber, searches for all the pathnames matching pattern according to the rules used.

Package owned SilexJS.

Install

$ npm install silex-glob

Usage

var glob = require('silex-glob');
 
var list = glob('**/*.js', function(filePath) {
    // Reads all the files with the extension "js"
    // in the current folder and all subfolders (recursive)
});
// And the variable "list" returns an array with the list of found files

Documentation

glob(rules, [callback])

  • rules {String|Array|Object}
    • The rule can contain regular expressions, but she needs to be enclosed in parentheses
      • Example valid: ./**/*.(js|node) or ./**/*.mp([2-4]) or ...
      • Exemple incorrecte: ./**/*.mp[2-4] ([2-4] is not in parentheses)
    • String Search rule
    • Array List of search rules
    • Object List of search rules as Object (the "excludes" parameter is not yet functional)
      {
          includes: ['./**/*.(js|node)', './**/*.mp([2-4])'],
          excludes: [],
      }
  • callback {Function}
    • Callback function is called each time a file is found. If the function returns false, then the file is not added to the list returned by Glob, otherwise it is added.

Package Sidebar

Install

npm i silex-glob

Weekly Downloads

3

Version

0.1.5

License

MIT

Last publish

Collaborators

  • sitexw