|
||
---|---|---|
.. | ||
lib | ||
index.js | ||
LICENSE | ||
package.json | ||
README.md |
matched
![Build Status](https://img.shields.io/travis/jonschlinkert/matched.svg?style=flat)
Adds array support to node-glob, sync and async. Also supports tilde expansion (user home) and resolving to global npm modules.
TOC
- Install
- Usage
- Release history
- Related projects
- Contributing
- Building docs
- Running tests
- Author
- License
(TOC generated by verb using markdown-toc)
Install
Install with npm:
$ npm install --save matched
Usage
If non-glob patterns (e.g. file paths) are passed, only paths that exist on the file system are returned.
var glob = require('matched');
async
glob(['*.js'], function(err, files) {
//=> ['utils.js', 'index.js']
});
sync
var files = glob.sync(['*.js']);
//=> ['utils.js', 'index.js']
promise
glob.promise(['*.txt'])
.then(function(files) {
//=> ['a.txt', 'b.txt', 'c.txt']
});
options
All methods take options as the second argument:
glob(['*.js'], {cwd: 'test'}, function(err, files) {
//=> ['test.js']
});
Release history
v0.4.1
- Exposes a non-enumerable
cache
property on the returned files array. This is a patch relase since the property does not change the existing API and should not otherwise effect behavior or results.
Related projects
You might also be interested in these projects:
- is-glob: Returns
true
if the given string looks like a glob pattern or an extglob pattern… more | homepage - look-up: Faster drop-in replacement for find-up and findup-sync. | homepage
- micromatch: Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | homepage
Contributing
This document was generated by verb-readme-generator (a verb generator), please don't edit directly. Any changes to the readme must be made in .verb.md. See Building Docs.
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Or visit the verb-readme-generator project to submit bug reports or pull requests for the readme layout template.
Building docs
(This document was generated by verb-readme-generator (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)
Generate readme and API documentation with verb:
$ npm install -g verb verb-readme-generator && verb
Running tests
Install dev dependencies:
$ npm install -d && npm test
Author
Jon Schlinkert
License
Copyright © 2016, Jon Schlinkert. Released under the MIT license.
This file was generated by verb, v0.9.0, on July 03, 2016.