Skip to content
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

If emitter.off provides only the event, remove all listeners for that event. #124

Merged
merged 3 commits into from
Jun 22, 2021
Merged

If emitter.off provides only the event, remove all listeners for that event. #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5f2ccef
Add new features of emitter.off. Fixes #123
sealice Jan 4, 2021
ec9122b
Fix the format and update the off API
sealice Jan 11, 2021
53eb689
Merge branch 'master' into patch_123
developit Jun 22, 2021
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
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ Register an event handler for the given type.
### off

Remove an event handler for the given type.
If omit the `handler`, all event handlers of the given type are deleted.

#### Parameters

Expand Down
14 changes: 10 additions & 4 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export interface Emitter<Events extends Record<EventType, unknown>> {
on<Key extends keyof Events>(type: Key, handler: Handler<Events[Key]>): void;
on(type: '*', handler: WildcardHandler<Events>): void;

off<Key extends keyof Events>(type: Key, handler: Handler<Events[Key]>): void;
off<Key extends keyof Events>(type: Key, handler?: Handler<Events[Key]>): void;
off(type: '*', handler: WildcardHandler<Events>): void;

emit<Key extends keyof Events>(type: Key, event: Events[Key]): void;
Expand Down Expand Up @@ -67,14 +67,20 @@ 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 {Function} handler Handler function to remove
* @param {Function} [handler] Handler function to remove
* @memberOf mitt
*/
off<Key extends keyof Events>(type: Key, handler: GenericEventHandler) {
off<Key extends keyof Events>(type: Key, handler?: GenericEventHandler) {
const handlers: Array<GenericEventHandler> | undefined = all!.get(type);
if (handlers) {
handlers.splice(handlers.indexOf(handler) >>> 0, 1);
if (handler) {
handlers.splice(handlers.indexOf(handler) >>> 0, 1);
}
else {
all.delete(type);
}
}
},

Expand Down