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.
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
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).
NOTE: As of v1.2.0, anymatch uses micromatch
for glob pattern matching. The glob matching behavior should be functionally
equivalent to the commonly used minimatch
library (aside from some fixed bugs and greater performance), so a major
version bump wasn't merited. Issues with glob pattern matching should be
reported directly to the micromatch issue tracker.