https://github.com/jonschlinkert/is-match
Create a matching function from a glob pattern, regex, string, array or function.
https://github.com/jonschlinkert/is-match
glob-pattern match test
Last synced: 15 days ago
JSON representation
Create a matching function from a glob pattern, regex, string, array or function.
- Host: GitHub
- URL: https://github.com/jonschlinkert/is-match
- Owner: jonschlinkert
- License: mit
- Created: 2015-02-03T06:12:26.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2017-06-18T02:06:20.000Z (almost 9 years ago)
- Last Synced: 2025-08-20T21:53:55.106Z (7 months ago)
- Topics: glob-pattern, match, test
- Language: JavaScript
- Size: 34.2 KB
- Stars: 20
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# is-match [](https://www.npmjs.com/package/is-match) [](https://npmjs.org/package/is-match) [](https://npmjs.org/package/is-match) [](https://travis-ci.org/jonschlinkert/is-match)
> Create a matching function from a glob pattern, regex, string, array, object or function.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save is-match
```
## Heads up!
See the [release history](#release-history) to learn about breaking changes in the [v1.0.0 release](https://github.com/jonschlinkert/is-match/releases/tag/1.0.0).
## Usage
```js
var isMatch = require('is-match');
```
### Create matchers:
**from a string:**
```js
var isMatch = matcher('a')
isMatch('a');
//=> true
isMatch('b');
//=> false
```
**from a glob pattern:**
```js
var isMatch = matcher('*')
isMatch('a'); //=> true
var isMatch = matcher('!b')
isMatch('a'); //=> true
var isMatch = matcher('!b')
isMatch('b'); //=> false
```
**from an array of glob patterns:**
```js
var isMatch = matcher(['b'])
isMatch('a'); //=> false
var isMatch = matcher(['b', 'a'])
isMatch('a'); //=> true
var isMatch = matcher(['b', 'c', '*'])
isMatch('a'); //=> true
```
**from a regex:**
```js
var isMatch = matcher(/a/);
isMatch('a');
//=> true
isMatch('b');
//=> false
```
**from a function:**
```js
var isMatch = matcher(function (val) {
return val === 'a';
});
isMatch('a');
//=> true
isMatch('b');
//=> false
```
**from an object:**
```js
var isMatch = matcher({a: 'b'});
isMatch({a: 'b'}); //=> true
isMatch({a: 'b', c: 'd'}); //=> false
isMatch({e: 'f', c: 'd'}); //=> false
```
## Release history
### v1.0.0
**Potentially breaking changes**
* prior to 1.0, when an array of globs was passed, `isMatch()` would return true if _any_ of the globs matched. As of 1.0, `isMatch()` only returns true when _all_ globs match.
* now does number comparisons. there are several ways to compare numbers, I'm open to a discussion or changes if necessary.
## About
### Related projects
* [has-glob](https://www.npmjs.com/package/has-glob): Returns `true` if an array has a glob pattern. | [homepage](https://github.com/jonschlinkert/has-glob "Returns `true` if an array has a glob pattern.")
* [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")
* [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** |
| --- | --- |
| 23 | [jonschlinkert](https://github.com/jonschlinkert) |
| 8 | [tunnckoCore](https://github.com/tunnckoCore) |
### 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 17, 2017._