docs: recommend EventHandle.off() for event removal#8974
Merged
Conversation
The string-based EventHandler.off(name, callback, scope) is the universal EventEmitter idiom and dominates usage, but the handle returned by on()/once() removes exactly one subscription and is faster (no scan of the callback list) - a benefit previously documented only on the internal offByHandle(). Surface that guidance on the public on()/once()/off() JSDoc so the preferred removal path is discoverable. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Build size reportThis PR does not change the size of the minified bundles.
|
mvaligursky
added a commit
that referenced
this pull request
Jun 26, 2026
The string-based EventHandler.off(name, callback, scope) is the universal EventEmitter idiom and dominates usage, but the handle returned by on()/once() removes exactly one subscription and is faster (no scan of the callback list) - a benefit previously documented only on the internal offByHandle(). Surface that guidance on the public on()/once()/off() JSDoc so the preferred removal path is discoverable. Co-authored-by: Martin Valigursky <mvaligursky@snapchat.com> Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
EventHandler.on()/once()return anEventHandle, and callinghandle.off()removes exactly that subscription without scanning the callback list — but this advantage was documented only on the internaloffByHandle()(@ignore). The public API surface only showed the string-basedoff(name, callback, scope), which is the universal EventEmitter idiom and dominates usage (~2:1 in this repo).This adds guidance to the public
on()/once()/off()JSDoc so the preferred removal path is discoverable:on()/once()@returnsnow recommend retaining the handle and callingEventHandle#off, noting it removes exactly that subscription and is faster.off()description now scopes the string form to bulk/by-name removal and points to the handle for removing a single known subscription.Docs only — no runtime or signature changes.