Skip to content

Commit 09a9df0

Browse files
AndaristtunnckoCore
authored andcommitted
Removed outdated (untrue) API docs - chaining was removed in 53a44d8 (#44)
1 parent d728e90 commit 09a9df0

File tree

2 files changed

+0
-9
lines changed

2 files changed

+0
-9
lines changed

README.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,6 @@ If present, `"*"` handlers are invoked prior to type-matched handlers.
108108
- `type` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The event type to invoke
109109
- `evt` **\[Any]** Any value (object is recommended and powerful), passed to each handler
110110

111-
Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** the `mitt` instance for chaining
112-
113111
### on
114112

115113
Register an event handler for the given type.
@@ -119,8 +117,6 @@ Register an event handler for the given type.
119117
- `type` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Type of event to listen for, or `"*"` for all events
120118
- `handler` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** Function to call in response to given event
121119

122-
Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** the `mitt` instance for chaining
123-
124120
### off
125121

126122
Remove an event handler for the given type.
@@ -130,8 +126,6 @@ Remove an event handler for the given type.
130126
- `type` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Type of event to unregister `handler` from, or `"*"`
131127
- `handler` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** Handler function to remove
132128

133-
Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** the `mitt` instance for chaining
134-
135129
## Contribute
136130

137131
First off, thanks for taking the time to contribute!

src/index.js

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ export default function mitt(all: EventHandlerMap) {
2222
*
2323
* @param {String} type Type of event to listen for, or `"*"` for all events
2424
* @param {Function} handler Function to call in response to given event
25-
* @return {Object} the `mitt` instance for chaining
2625
* @memberOf mitt
2726
*/
2827
on(type: string, handler: EventHandler) {
@@ -34,7 +33,6 @@ export default function mitt(all: EventHandlerMap) {
3433
*
3534
* @param {String} type Type of event to unregister `handler` from, or `"*"`
3635
* @param {Function} handler Handler function to remove
37-
* @return {Object} the `mitt` instance for chaining
3836
* @memberOf mitt
3937
*/
4038
off(type: string, handler: EventHandler) {
@@ -48,7 +46,6 @@ export default function mitt(all: EventHandlerMap) {
4846
*
4947
* @param {String} type The event type to invoke
5048
* @param {Any} [evt] Any value (object is recommended and powerful), passed to each handler
51-
* @return {Object} the `mitt` instance for chaining
5249
* @memberof mitt
5350
*/
5451
emit(type: string, evt: EventHandler) {

0 commit comments

Comments
 (0)