[SDK-3883] Remove ability to pass array of event names to EventEmitter.prototype.once
#1453
Conversation
This file contains 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
github-actions
bot
temporarily deployed
to
staging/pull/1453/features
github-actions
bot
temporarily deployed
to
staging/pull/1453/bundle-report
github-actions
bot
temporarily deployed
to
staging/pull/1453/typedoc
lawrence-forooghian
changed the title
EventEmitter.prototype.onceEventEmitter.prototype.once
lawrence-forooghian
force-pushed
the
1452-remove-EventEmitter-once-multiple-events
branch
from
8a2d2ab to
412534c
Compare
github-actions
bot
temporarily deployed
to
staging/pull/1453/features
github-actions
bot
temporarily deployed
to
staging/pull/1453/bundle-report
github-actions
bot
temporarily deployed
to
staging/pull/1453/typedoc
….once This functionality is implemented by wrapping the listener argument in another listener. This means that the event emitter does not hold a reference to the listener argument (other than that held indirectly through the wrapper) and so it is not possible to remove this listener using `off(..., listener)`. The client library specification does not specify a version of `once` which accepts an array of event names, and we do not advertise it as part of the public API. So, I think the simplest thing is to remove this functionality. Resolves #1452.
lawrence-forooghian
force-pushed
the
1452-remove-EventEmitter-once-multiple-events
branch
from
412534c to
cd4f7b3
Compare
|
I'm don't think outright removing this is a good idea - the method is still useful as long as you don't have a need to remove the listener? I agree the implementation is bad but this is a breaking change to something that, at least partially, works. I think the only real options pre-v2 of the library are to soft-deprecate/add a warning or to just fix it. |
|
Thanks @owenpearson, I've created #1470 and will put it in the v2 epic. |
|
Closing this since we decided in #1470 that we'll fix and keep. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This functionality is implemented by wrapping the listener argument in another listener. This means that the event emitter does not hold a reference to the listener argument (other than that held indirectly through the wrapper) and so it is not possible to remove this listener using
off(..., listener).The client library specification does not specify a version of
oncewhich accepts an array of event names, and we do not advertise it as part of the public API. So, I think the simplest thing is to remove this functionality.Resolves #1452.