# matched > Adds array support to node-glob, sync and async. Also supports tilde expansion (user home) and resolving to global npm modules. Latest version **5.0.1** (published 2020-11-02) · MIT license · 0 weekly downloads ## Install ```sh npm install matched pnpm add matched yarn add matched bun add matched ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 5.0.1 | | Published | 2020-11-02 | | First published | 2014-05-03 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=10 | | Dependencies | 2 | | Unpacked size | 14.8 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 26 | | Author | Jon Schlinkert | | Maintainers | trysound, jonschlinkert, doowb | | Keywords | array, directories, exclude, exclusions, expand, files, filesystem, find, fnmatch, folders, fs, glob, globbing, globby, globs, globstar, lookup, match, matched, matcher, matching, minimatch, multi, multimatch, multiple, negate, node, node-glob, paths, pattern, patterns, star, wildcard, wildcards | ## Links - npm: https://www.npmjs.com/package/matched - Repository: https://github.com/jonschlinkert/matched - Issues: https://github.com/jonschlinkert/matched/issues - Funding: https://github.com/sponsors/jonschlinkert - npm.io page: https://npm.io/package/matched ## Dependencies (2) - [glob](https://npm.io/package/glob.md) ^7.1.6 - [picomatch](https://npm.io/package/picomatch.md) ^2.2.1 ## Alternatives - [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads - [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads - [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads - [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads - [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads ## Recent versions - 5.0.1 (latest) — 2020-11-02 - 5.0.0 — 2020-01-15 - 4.0.0 — 2019-04-29 - 3.0.1 — 2018-08-27 - 3.0.0 — 2018-08-27 - 2.0.1 — 2018-03-22 - 2.0.0 — 2018-03-22 - 1.0.2 — 2017-06-23 - 1.0.1 — 2017-06-23 - 0.4.4 — 2016-09-01 - 0.4.3 — 2016-07-03 - 0.4.2 — 2016-07-02 - 0.4.1 — 2016-01-03 - 0.4.0 — 2015-12-28 - 0.3.2 — 2015-10-12 - … 8 more at https://npm.io/package/matched/versions ## README # matched [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=W8YFZ425KND68) [![NPM version](https://img.shields.io/npm/v/matched.svg?style=flat)](https://www.npmjs.com/package/matched) [![NPM monthly downloads](https://img.shields.io/npm/dm/matched.svg?style=flat)](https://npmjs.org/package/matched) [![NPM total downloads](https://img.shields.io/npm/dt/matched.svg?style=flat)](https://npmjs.org/package/matched) [![Build Status](https://travis-ci.org/jonschlinkert/matched.svg?branch=master)](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. Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support. ## Install Install with [npm](https://www.npmjs.com/) (requires [Node.js](https://nodejs.org/en/) >=10): ```sh $ npm install --save matched ``` ## Usage ```js const glob = require('matched'); // async signature glob(patterns[, options]); // sync signature glob.sync(patterns[, options]); ``` * `patterns` (string|array) - one or more glob patterns * `options` - options to pass to [node-glob](https://github.com/isaacs/node-glob); _Also note that if non-glob file paths are passed, only paths that exist on the file system will be returned._ **promise** ```js glob(['*.txt']) .then(files => console.log(files)) //=> ['a.txt', 'b.txt', 'c.txt'] .catch(console.error) // or with async-await (async() => { const files = await glob('*.txt'); console.log(files); //=> ['foo.txt', 'bar.txt'] })(); ``` **callback** ```js glob(['*.js'], (err, files) => { console.log(files); //=> ['utils.js', 'index.js'] }); ``` **sync** ```js const files = glob.sync(['*.js']); //=> ['utils.js', 'index.js'] ``` **options** All methods take an options object to be forwarded to [node-glob](https://github.com/isaacs/node-glob) as the second argument. ```js const files = glob(['*.js'], { cwd: 'test' }); console.log(files); //=> ['test.js'] ``` ## v4.1 * Adds support for `options.onMatch()` which is passed to [node-glob](https://github.com/isaacs/node-glob) as a listener for the `match` event. * Adds support for `options.onFiles()` to allow the user to get the files returned by each glob pattern. * Small optimizations in logic for handling non-glob patterns that are passed for matching literal file names. ## v4.0 * Use [picomatch](https://github.com/micromatch/picomatch) for parsing glob patterns. ## v3.0 * Removes `cache` property from results array. * Optimizations ## v0.4.1 * Exposes a non-enumerable `cache` property on the returned files array. This is a patch release since the property does not change the existing API and should not otherwise effect behavior or results. ## About
Contributing Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
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 ```
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 ```
### Related projects You might also be interested in these projects: * [findup-sync](https://www.npmjs.com/package/findup-sync): Find the first file matching a given pattern in the current directory or the nearest… [more](https://github.com/gulpjs/findup-sync#readme) | [homepage](https://github.com/gulpjs/findup-sync#readme "Find the first file matching a given pattern in the current directory or the nearest ancestor directory.") * [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/micromatch/is-glob) | [homepage](https://github.com/micromatch/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") * [micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A replacement and faster alternative to minimatch and multimatch. | [homepage](https://github.com/micromatch/micromatch "Glob matching for javascript/node.js. A replacement and faster alternative to minimatch and multimatch.") ### Contributors | **Commits** | **Contributor** | | --- | --- | | 73 | [jonschlinkert](https://github.com/jonschlinkert) | | 8 | [TrySound](https://github.com/TrySound) | | 1 | [sindresorhus](https://github.com/sindresorhus) | ### Author **Jon Schlinkert** * [GitHub Profile](https://github.com/jonschlinkert) * [Twitter Profile](https://twitter.com/jonschlinkert) * [LinkedIn Profile](https://linkedin.com/in/jonschlinkert) ### License Copyright © 2020, [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.8.0, on January 15, 2020._ --- _Source: https://npm.io/package/matched · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._