117 lines
4.0 KiB
Markdown
117 lines
4.0 KiB
Markdown
# matched [](https://www.npmjs.com/package/matched) [](https://npmjs.org/package/matched) [](https://npmjs.org/package/matched) [](https://travis-ci.org/jonschlinkert/matched)
|
|
|
|
> Adds array support to node-glob, sync and async. Also supports tilde expansion (user home) and resolving to global npm modules.
|
|
|
|
## Install
|
|
|
|
Install with [npm](https://www.npmjs.com/):
|
|
|
|
```sh
|
|
$ 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.
|
|
|
|
```js
|
|
var glob = require('matched');
|
|
```
|
|
|
|
**async**
|
|
|
|
```js
|
|
glob(['*.js'], function(err, files) {
|
|
//=> ['utils.js', 'index.js']
|
|
});
|
|
```
|
|
|
|
**sync**
|
|
|
|
```js
|
|
var files = glob.sync(['*.js']);
|
|
//=> ['utils.js', 'index.js']
|
|
```
|
|
|
|
**promise**
|
|
|
|
```js
|
|
glob.promise(['*.txt'])
|
|
.then(function(files) {
|
|
//=> ['a.txt', 'b.txt', 'c.txt']
|
|
});
|
|
```
|
|
|
|
**options**
|
|
|
|
All methods take options as the second argument:
|
|
|
|
```js
|
|
glob(['*.js'], {cwd: 'test'}, function(err, files) {
|
|
//=> ['test.js']
|
|
});
|
|
```
|
|
|
|
## Release history
|
|
|
|
### v1.0.0
|
|
|
|
* Minor code improvements, dependency upgrades
|
|
|
|
### 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.
|
|
|
|
## About
|
|
|
|
### Related projects
|
|
|
|
* [is-glob](https://www.npmjs.com/package/is-glob): Returns `true` if the given string looks like a glob pattern or an extglob pattern… [more](https://github.com/jonschlinkert/is-glob) | [homepage](https://github.com/jonschlinkert/is-glob "Returns `true` if the given string looks like a glob pattern or an extglob pattern. This makes it easy to create code that only uses external modules like node-glob when necessary, resulting in much faster code execution and initialization time, and a bet")
|
|
* [look-up](https://www.npmjs.com/package/look-up): Faster drop-in replacement for find-up and findup-sync. | [homepage](https://github.com/jonschlinkert/look-up "Faster drop-in replacement for find-up and findup-sync.")
|
|
* [micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | [homepage](https://github.com/micromatch/micromatch "Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.")
|
|
|
|
### Contributing
|
|
|
|
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
|
|
|
|
### Contributors
|
|
|
|
| **Commits** | **Contributor** |
|
|
| --- | --- |
|
|
| 48 | [jonschlinkert](https://github.com/jonschlinkert) |
|
|
| 7 | [TrySound](https://github.com/TrySound) |
|
|
| 1 | [sindresorhus](https://github.com/sindresorhus) |
|
|
|
|
### Building docs
|
|
|
|
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
|
|
|
|
To generate the readme, run the following command:
|
|
|
|
```sh
|
|
$ npm install -g verbose/verb#dev verb-generate-readme && verb
|
|
```
|
|
|
|
### Running tests
|
|
|
|
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
|
|
|
|
```sh
|
|
$ npm install && npm test
|
|
```
|
|
|
|
### Author
|
|
|
|
**Jon Schlinkert**
|
|
|
|
* [github/jonschlinkert](https://github.com/jonschlinkert)
|
|
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
|
|
|
|
### License
|
|
|
|
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
|
|
Released under the [MIT License](LICENSE).
|
|
|
|
***
|
|
|
|
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on June 23, 2017._ |