aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJason Miller <[email protected]>2022-01-31 09:28:26 -0500
committerGitHub <[email protected]>2022-01-31 09:28:26 -0500
commitf9a0b5397edfe10c8ad0629e08ae4f123b4d65fa (patch)
treecc0c86cc52534a666ae78bb0dd6a6ff5a08a85d5
parent13905bd4009e83f1876f2d31419e23cdbf4f9b48 (diff)
Clarify what `off('*')` does
Fixes #150
-rw-r--r--src/index.ts2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/index.ts b/src/index.ts
index dfc0c1f..7301520 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -70,7 +70,7 @@ export default function mitt<Events extends Record<EventType, unknown>>(
/**
* Remove an event handler for the given type.
* If `handler` is omitted, all handlers of the given type are removed.
- * @param {string|symbol} type Type of event to unregister `handler` from, or `'*'`
+ * @param {string|symbol} type Type of event to unregister `handler` from (`'*'` to remove a wildcard handler)
* @param {Function} [handler] Handler function to remove
* @memberOf mitt
*/