anymatch
Last updated
Last updated
Javascript module to match a string against a regular expression, glob, string, or function that takes the string as an argument and returns a truthy or falsy value. The matcher can also be an array of any or all of these. Useful for allowing a very flexible user-defined config to define things like file paths.
Note: This module has Bash-parity, please be aware that Windows-style backslashes are not supported as separators. See https://github.com/micromatch/micromatch#backslashes for more information.
matchers: (Array|String|RegExp|Function) String to be directly matched, string with glob patterns, regular expression test, function that takes the testString as an argument and returns a truthy value if it should be matched, or an array of any number and mix of these types.
testString: (String|Array) The string to test against the matchers. If passed as an array, the first element of the array will be used as the testString
for non-function matchers, while the entire array will be applied as the arguments for function matchers.
returnIndex: (Boolean [optional]) If true, return the array index of the first matcher that that testString matched, or -1 if no match, instead of a boolean result.
startIndex, endIndex: (Integer [optional]) Can be used to define a subset out of the array of provided matchers to test against. Can be useful with bound matcher functions (see below). When used with returnIndex = true
preserves original indexing. Behaves the same as Array.prototype.slice
(i.e. includes array members up to, but not including endIndex).
You can also pass in only your matcher(s) to get a curried function that has already been bound to the provided matching criteria. This can be used as an Array.prototype.filter
callback.
See release notes page on GitHub
NOTE: As of v2.0.0, micromatch moves away from minimatch-parity and inline with Bash. This includes handling backslashes differently (see https://github.com/micromatch/micromatch#backslashes for more information).
NOTE: As of v1.2.0, anymatch uses micromatch for glob pattern matching. Issues with glob pattern matching should be reported directly to the micromatch issue tracker.