This repository has been archived by the owner on Apr 22, 2023. It is now read-only.
docs:events clarify that emitter.listener() returns a copy #9321
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
| @@ -104,7 +104,7 @@ Note that `emitter.setMaxListeners(n)` still has precedence over | |||
|
|
|||
| ### emitter.listeners(event) | |||
|
|
|||
| Returns an array of listeners for the specified event. | |||
| Returns a copy of an array of listeners for the specified event. | |||
There was a problem hiding this comment.
Maybe change this to Returns a copy of the array...
There was a problem hiding this comment.
That would be lying though. Sometimes that array doesn't exist until you call .listeners(event)
There was a problem hiding this comment.
That seems like an implementation detail that shouldn't be relevant to a user of the API.
|
LGTM ... happy with either "an" or "the" |
|
I'll change it to "the" haha. Let me just figure out how to make the change without adding an extra commit. |
Clarifies that emitter.listener() returns a copy, not a reference Resolves issue nodejs#9022
|
LGTM. Will land shortly in a batch with other doc improvements... |
|
Closing this. Landed in nodejs/node |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Clarifies that emitter.listener() returns a copy, not a reference
Resolves issue #9022