fixed: controversies btw index.d.ts and readme.md

valango · valango · commit ee30306efcf7 · 2021-05-09T14:34:26.000+03:00
diff --git a/index.d.ts b/index.d.ts
@@ -16,8 +16,8 @@ declare const matcher: {
 	It matches even across newlines. For example, `foo*r` will match `foo\nbar`.
 
 	@param inputs - String or array of strings to match.
-	@param patterns - String or array of string patterns.
-	@returns The `inputs` filtered based on the `patterns`.
+	@param patterns - String or array of string patterns. Use `*` to match zero or more characters. A leading `!` negates the pattern.
+	@returns An array of `inputs` filtered based on the `patterns`.
 
 	@example
 	```
@@ -80,8 +80,8 @@ declare const matcher: {
 	It matches even across newlines. For example, `foo*r` will match `foo\nbar`.
 
 	@param inputs - String or array of strings to match.
-	@param patterns - String or array of string patterns. Use `*` to match zero or more characters. A pattern starting with `!` will be negated.
-	@returns Whether any given `input` matches every given `pattern`.
+	@param patterns - String or array of string patterns. Use `*` to match zero or more characters. A leading `!` negates the pattern.
+	@returns Whether any of given `inputs` matches all the `patterns`.
 
 	@example
 	```
diff --git a/readme.md b/readme.md
@@ -89,13 +89,13 @@ Accepts a string or an array of strings for both `inputs` and `patterns`.
 
 Returns an array of `inputs` filtered based on the `patterns`.
 
-### matcher.isMatch(input, pattern, options?)
+### matcher.isMatch(inputs, patterns, options?)
 
 Accepts a string or an array of strings for both `inputs` and `patterns`.
 
-Returns a `boolean` of whether any given `input` matches every given `pattern`.
+Returns a `boolean` of whether any of given `inputs` matches all the `patterns`.
 
-#### input
+#### inputs
 
 Type: `string | string[]`
 
@@ -114,7 +114,7 @@ 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
+#### patterns
 
 Type: `string | string[]`
 
