matcher
Simple wildcard matching
Useful when you want to accept loose string input and regexes/globs are too convoluted.
Install
$ npm install matcher
Usage
const matcher = require('matcher');
matcher(['foo', 'bar', 'moo'], ['*oo', '!foo']);
matcher(['foo', 'bar', 'moo'], ['!*oo']);
matcher.isMatch('unicorn', 'uni*');
matcher.isMatch('unicorn', '*corn');
matcher.isMatch('unicorn', 'un*rn');
matcher.isMatch('rainbow', '!unicorn');
matcher.isMatch('foo bar baz', 'foo b* b*');
matcher.isMatch('unicorn', 'uni\\*');
matcher.isMatch('UNICORN', 'UNI*', {caseSensitive: true});
matcher.isMatch('UNICORN', 'unicorn', {caseSensitive: true});
API
matcher(inputs, patterns, [options])
Accepts an array of input
's and pattern
's.
Returns an array of inputs
filtered based on the patterns
.
matcher.isMatch(input, pattern, [options])
Returns a boolean
of whether the input
matches the pattern
.
input
Type: string
String to match.
options
Type: object
caseSensitive
Type: boolean
Default: false
Treat uppercase and lowercase characters as being the same.
Ensure you use this correctly. For example, files and directories should be matched case-insensitively, while most often, object keys should be matched case-sensitively.
pattern
Type: string
Use *
to match zero or more characters. A pattern starting with !
will be negated.
Benchmark
$ npm run bench
Related
- matcher-cli - CLI for this module
- multimatch - Extends
minimatch.match()
with support for multiple patterns
License
MIT © Sindre Sorhus