# maximatch

> Extends multimatch() with support for filter functions and regular expressions

Latest version **0.1.0** (published 2016-01-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install maximatch
pnpm add maximatch
yarn add maximatch
bun add maximatch
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2016-01-12 |
| First published | 2016-01-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Tim Kendrick |
| Maintainers | timkendrick |
| Keywords | expand, find, glob, globbing, globs, match, matcher, minimatch, multimatch, pattern, patterns, wildcard |

## Links

- npm: https://www.npmjs.com/package/maximatch
- Repository: https://github.com/timkendrick/maximatch
- Homepage: https://github.com/timkendrick/maximatch#readme
- Issues: https://github.com/timkendrick/maximatch/issues
- npm.io page: https://npm.io/package/maximatch

## Dependencies (4)

- [arrify](https://npm.io/package/arrify.md) ^1.0.0
- [minimatch](https://npm.io/package/minimatch.md) ^3.0.0
- [array-union](https://npm.io/package/array-union.md) ^1.0.1
- [array-differ](https://npm.io/package/array-differ.md) ^1.0.0

## Recent versions

- 0.1.0 (latest) — 2016-01-12

## README

# maximatch [![Build Status](https://travis-ci.org/timkendrick/maximatch.svg?branch=master)](https://travis-ci.org/timkendrick/maximatch)

> Extends [`multimatch()`](https://github.com/sindresorhus/multimatch) with support for filter functions and regular expressions


## Install

```sh

$ npm install --save maximatch
```


## Usage

```js
var maximatch = require('maximatch');

maximatch(['unicorn', 'cake', 'rainbows'], ['*', '!cake']);
//=> ['unicorn', 'rainbows']

maximatch(['unicorn', 'cake', 'rainbows'], function(path) { return path.length > 4; });
//=> ['unicorn', 'rainbows']

maximatch(['unicorn', 'cake', 'rainbows'], /^[^k]+$/);
//=> ['unicorn', 'rainbows']

maximatch(['unicorn', 'cake', 'rainbows'], [function(path) { return path.charAt(0) === 'u'; }, /w/]);
//=> ['unicorn', 'rainbows']
```

See the [tests](https://github.com/timkendrick/multimatch/blob/master/test.js) for more usage examples and expected matches.


## API

Same as [`minimatch.match()`](https://github.com/isaacs/minimatch#minimatchmatchlist-pattern-options) except for `pattern` also accepting a filter function, a regular expression, or an array that can contain globs, filter functions and regular expressions.

```js
var results = maximatch(paths, patterns);
```

The return value is an array of matching paths.


## How multiple patterns work

Positive patterns (e.g. `foo` or `*`) add to the results, while negative patterns (e.g. `!foo`) subtract from the results.

Therefore a lone negation (e.g. `['!foo']`) will never match anything – use `['*', '!foo']` instead.


## Globbing patterns

Just a quick overview.

- `*` matches any number of characters, but not `/`
- `?` matches a single character, but not `/`
- `**` matches any number of characters, including `/`, as long as it's the only thing in a path part
- `{}` allows for a comma-separated list of "or" expressions
- `!` at the beginning of a pattern will negate the match


## Related

See [globby](https://github.com/sindresorhus/globby) if you need to match against the filesystem instead of a list.


## License

MIT © [Sindre Sorhus](http://sindresorhus.com), [Jon Schlinkert](https://github.com/jonschlinkert), [Tim Kendrick](https://github.com/timkendrick)

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