![\"npm](\"https://img.shields.io/npm/v/wildcard-match\")
\n \n ![\"size\"](\"https://img.shields.io/bundlephobia/minzip/wildcard-match?color=%23b4a&label=size\")
\n \n ![\"CI\"](\"https://img.shields.io/github/actions/workflow/status/axtgr/wildcard-match/ci.yml?label=CI&logo=github\")
\n \n ![\"Buy](\"https://img.shields.io/badge/%F0%9F%8D%BA-Buy%20me%20a%20beer-red?style=flat\"){kind=icon}
\n\n A tiny and extremely fast JavaScript library for compiling and matching basic glob patterns\n
\n\n\n
| 🍃 | \nLightweight No dependencies. Less than 1 KB when minified and gzipped | \n
| 🏎 | \nFast Compiles and matches patterns faster than any other known library | \n
| 🌞 | \nSimple The API is a single function | \n
| ⚒ | \nReliable Written in TypeScript. Covered by hundreds of unit tests | \n
| 🔌 | \nCompatible Works in any ES5+ environment including older versions of Node.js, Bun, Deno, React Native and browsers | \n
/\\*\\*/ if / is the separator)\n- `\\` escapes the following character making it be treated literally\n\nMore features are available in the [outmatch](https://github.com/axtgr/outmatch) library.\n\n### Separators\n\nGlobs are most often used to search file paths, which are, essentially, strings split into segments by slashes. While other libraries are usually restricted to this use-case, wildcard-match is able to work with _arbitrary_ strings by accepting a custom separator in the second parameter:\n\n```js\nconst matchDomain = wcmatch('*.example.com', { separator: '.' })\nmatchDomain('subdomain.example.com') //=> true\n\n// Here, the second parameter is a shorthand for `{ separator: ',' }`\nconst matchLike = wcmatch('one,**,f?ur', ',')\nmatchLike('one,two,three,four') //=> true\n```\n\nThe only limitation is that backslashes `\\` cannot be used as separators in patterns because\nwildcard-match uses them for character escaping. However, when `separator` is `undefined`\nor `true`, `/` in patterns will match both `/` and `\\`, so a single pattern with forward\nslashes can match both Unix and Windows paths:\n\n```js\nconst isMatchA = outmatch('foo\\\\bar') // throws an error\n\nconst isMatchB = outmatch('foo/bar') // same as passing `true` as the separator\n\nisMatchB('foo/bar') //=> true\nisMatchB('foo\\\\bar') //=> true\n\nconst isMatchC = outmatch('foo/bar', '/')\n\nisMatchC('foo/bar') //=> true\nisMatchC('foo\\\\bar') //=> false\n```\n\nThe matching features work with a _segment_ rather than a whole pattern:\n\n```js\nconst isMatch = wcmatch('foo/b*')\n\nisMatch('foo/bar') //=> true\nisMatch('foo/b/ar') //=> false\n```\n\nSegmentation can be turned off completely by passing `false` as the separator, which makes wildcard-match treat whole patterns as a single segment. Slashes become regular symbols and `*` matches _anything_:\n\n```js\nconst isMatch = wcmatch('foo?ba*', false)\nisMatch('foo/bar/qux') //=> true\n```\n\nA single separator in a pattern will match _one or more_ separators in a sample string:\n\n```js\nwcmatch('foo/bar/baz')('foo/bar///baz') //=> true\n```\n\nWhen a pattern has an explicit separator at its end, samples also require one or more trailing separators:\n\n```js\nconst isMatch = wcmatch('foo/bar/')\n\nisMatch('foo/bar') //=> false\nisMatch('foo/bar/') //=> true\nisMatch('foo/bar///') //=> true\n```\n\nHowever, if there is no trailing separator in a pattern, strings will match even if they have separators at the end:\n\n```js\nconst isMatch = wcmatch('foo/bar')\n\nisMatch('foo/bar') //=> true\nisMatch('foo/bar/') //=> true\nisMatch('foo/bar///') //=> true\n```\n\n### Multiple Patterns\n\nWildcard-match can take an array of glob patterns as the first argument instead of a single pattern. In that case a string will be considered a match if it matches _any_ of the given patterns:\n\n```js\nconst isMatch = wcmatch(['src/*', 'tests/*'])\n\nisMatch('src/utils.js') //=> true\nisMatch('tests/utils.js') //=> true\n```\n\n### Matching Arrays of Strings\n\nThe returned function can work with arrays of strings when used as the predicate of the native array methods:\n\n```js\nconst isMatch = wcmatch('src/*.js')\nconst paths = ['readme.md', 'src/index.js', 'src/components/body.js']\n\npaths.map(isMatch) //=> [ false, true, false ]\npaths.filter(isMatch) //=> [ 'src/index.js' ]\npaths.some(isMatch) //=> true\npaths.every(isMatch) //=> false\npaths.find(isMatch) //=> 'src/index.js'\npaths.findIndex(isMatch) //=> 1\n```\n\n## API\n\n### wcmatch(patterns, options?): isMatch