# is-match

> Create a matching function from a glob pattern, regex, string, array, object or function.

Latest version **1.0.0** (published 2017-06-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install is-match
pnpm add is-match
yarn add is-match
bun add is-match
```

## 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 | 1.0.0 |
| Published | 2017-06-18 |
| First published | 2015-02-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 20 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | any, array, contains, expression, function, glob, has, is, match, matcher, matches, matching, minimatch, multimatch, object, pattern, patterns, regex, regexp, regular, value, where, wildcard |

## Links

- npm: https://www.npmjs.com/package/is-match
- Repository: https://github.com/jonschlinkert/is-match
- Issues: https://github.com/jonschlinkert/is-match/issues
- npm.io page: https://npm.io/package/is-match

## Dependencies (4)

- [kind-of](https://npm.io/package/kind-of.md) ^4.0.0
- [is-number](https://npm.io/package/is-number.md) ^3.0.0
- [deep-equal](https://npm.io/package/deep-equal.md) ^1.0.1
- [micromatch](https://npm.io/package/micromatch.md) ^3.0.3

## Alternatives

- [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads
- [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads
- [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads
- [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads
- [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2017-06-18
- 0.4.1 — 2016-04-21
- 0.4.0 — 2015-09-08
- 0.3.4 — 2015-08-01
- 0.3.3 — 2015-06-19
- 0.3.2 — 2015-06-19
- 0.3.1 — 2015-06-19
- 0.3.0 — 2015-06-19
- 0.2.0 — 2015-05-05
- 0.1.0 — 2015-02-03

## README

# is-match [![NPM version](https://img.shields.io/npm/v/is-match.svg?style=flat)](https://www.npmjs.com/package/is-match) [![NPM monthly downloads](https://img.shields.io/npm/dm/is-match.svg?style=flat)](https://npmjs.org/package/is-match) [![NPM total downloads](https://img.shields.io/npm/dt/is-match.svg?style=flat)](https://npmjs.org/package/is-match) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/is-match.svg?style=flat&label=Travis)](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._

---
_Source: https://npm.io/package/is-match · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._