Skip to content

on now returns a deregistration function #215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
matthias-ccri wants to merge 1 commit into
base: main
Choose a base branch
from
Open

on now returns a deregistration function #215

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,16 +51,18 @@ export default function mitt<Events extends Record<EventType, unknown>>(
| WildcardHandler<Events>;
all = all || new Map();

return {
const mittInstance = {
/**
* A Map of event names to registered handler functions.
*/
all,

/**
* Register an event handler for the given type.
* Returns a deregistration function.
* @param {string|symbol} type Type of event to listen for, or `'*'` for all events
* @param {Function} handler Function to call in response to given event
* @returns {Function}
* @memberOf mitt
*/
on<Key extends keyof Events>(type: Key, handler: GenericEventHandler) {
Expand All @@ -70,6 +72,9 @@ export default function mitt<Events extends Record<EventType, unknown>>(
} else {
all!.set(type, [handler] as EventHandlerList<Events[keyof Events]>);
}
return () => {
mittInstance.off(type, handler);
};
},

/**
Expand Down Expand Up @@ -120,4 +125,6 @@ export default function mitt<Events extends Record<EventType, unknown>>(
}
}
};

return mittInstance;
}