diff options
Diffstat (limited to 'node_modules/matcher/readme.md')
| -rw-r--r-- | node_modules/matcher/readme.md | 120 |
1 files changed, 0 insertions, 120 deletions
diff --git a/node_modules/matcher/readme.md b/node_modules/matcher/readme.md deleted file mode 100644 index 962070a..0000000 --- a/node_modules/matcher/readme.md +++ /dev/null @@ -1,120 +0,0 @@ -# matcher [](https://travis-ci.com/sindresorhus/matcher) - -> Simple [wildcard](https://en.wikipedia.org/wiki/Wildcard_character) matching - -Useful when you want to accept loose string input and regexes/globs are too convoluted. - -## Install - -``` -$ npm install matcher -``` - -## Usage - -```js -const matcher = require('matcher'); - -matcher(['foo', 'bar', 'moo'], ['*oo', '!foo']); -//=> ['moo'] - -matcher(['foo', 'bar', 'moo'], ['!*oo']); -//=> ['bar'] - -matcher.isMatch('unicorn', 'uni*'); -//=> true - -matcher.isMatch('unicorn', '*corn'); -//=> true - -matcher.isMatch('unicorn', 'un*rn'); -//=> true - -matcher.isMatch('rainbow', '!unicorn'); -//=> true - -matcher.isMatch('foo bar baz', 'foo b* b*'); -//=> true - -matcher.isMatch('unicorn', 'uni\\*'); -//=> false - -matcher.isMatch('UNICORN', 'UNI*', {caseSensitive: true}); -//=> true - -matcher.isMatch('UNICORN', 'unicorn', {caseSensitive: true}); -//=> false - -matcher.isMatch(['foo', 'bar'], 'f*'); -//=> true - -matcher.isMatch(['foo', 'bar'], ['a*', 'b*']); -//=> true - -matcher.isMatch('unicorn', ['tri*', 'UNI*'], {caseSensitive: true}); -//=> false -``` - -## API - -It matches even across newlines. For example, `foo*r` will match `foo\nbar`. - -### 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?) - -Accepts either a string or array of strings for both `input` and `pattern`. - -Returns a `boolean` of whether any given `input` matches every given `pattern`. - -#### input - -Type: `string | string[]` - -String or array of strings 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 | string[]` - -Use `*` to match zero or more characters. A pattern starting with `!` will be negated. - -## Benchmark - -``` -$ npm run bench -``` - -## Related - -- [matcher-cli](https://github.com/sindresorhus/matcher-cli) - CLI for this module -- [multimatch](https://github.com/sindresorhus/multimatch) - Extends `minimatch.match()` with support for multiple patterns - ---- - -<div align="center"> - <b> - <a href="https://tidelift.com/subscription/pkg/npm-matcher?utm_source=npm-matcher&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a> - </b> - <br> - <sub> - Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies. - </sub> -</div> |