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

Jump to bottom

doc: Explicitly indicate that EventEmitter's listeners will still be invoked if they were removed during the emit cycle #4759

Closed
drjokepu opened this issue Jan 19, 2016 · 1 comment
Closed

doc: Explicitly indicate that EventEmitter's listeners will still be invoked if they were removed during the emit cycle #4759

drjokepu opened this issue Jan 19, 2016 · 1 comment
Labels
doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors.

Comments

@drjokepu
Copy link

As discussed in nodejs/node-v0.x-archive#7872, EventEmitter's listeners are still called if they are removed during the emit() cycle. It was agreed that this is the intended behavior, however, there is nothing in EventEmitter's documentation that would explicitly indicate that.

I think the documentation needs to be updated to clarify this behavior, because it's not necessarily obvious.
@cjihrig
Copy link
Contributor

cjihrig commented Jan 19, 2016

Documentation patches are welcome.

@Fishrock123 Fishrock123 added doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors. labels Jan 19, 2016
@drjokepu drjokepu mentioned this issue Jan 19, 2016
Closed
dirceu added a commit to dirceu/node that referenced this issue Feb 12, 2016
@dirceu
doc: emitter.removeListener clarification
9e33450 
Fix based on nodejs#4764 by
@drjokepu.

Fixes: nodejs#4759
vaibhav93 added a commit to vaibhav93/node that referenced this issue Feb 12, 2016
@vaibhav93
doc: update removeListener behaviour
7b91ac0 
This commit updates events doc to describe removeListener behaviour
when it is called within a listener. An example is added to make
it more evident.

A test is also incuded to make this behaviour consistent in future
releases.
fixes nodejs#4759
@vaibhav93 vaibhav93 mentioned this issue Feb 12, 2016
Closed
evanlucas pushed a commit that referenced this issue Mar 14, 2016
@vaibhav93 @evanlucas
doc: update removeListener behaviour
87b8c3b 
This commit updates events doc to describe removeListener behaviour
when it is called within a listener. An example is added to make
it more evident.

A test is also incuded to make this behaviour consistent in future
releases.

Fixes: #4759

PR-URL: #5201

Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
rvagg pushed a commit that referenced this issue Mar 16, 2016
@vaibhav93 @rvagg
doc: update removeListener behaviour
2a442b3 
This commit updates events doc to describe removeListener behaviour
when it is called within a listener. An example is added to make
it more evident.

A test is also incuded to make this behaviour consistent in future
releases.

Fixes: #4759

PR-URL: #5201

Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
MylesBorins pushed a commit that referenced this issue Mar 17, 2016
@vaibhav93
doc: update removeListener behaviour
115a980 
This commit updates events doc to describe removeListener behaviour
when it is called within a listener. An example is added to make
it more evident.

A test is also incuded to make this behaviour consistent in future
releases.

Fixes: #4759

PR-URL: #5201

Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
MylesBorins pushed a commit that referenced this issue Mar 21, 2016
@vaibhav93
doc: update removeListener behaviour
b1d580c 
This commit updates events doc to describe removeListener behaviour
when it is called within a listener. An example is added to make
it more evident.

A test is also incuded to make this behaviour consistent in future
releases.

Fixes: #4759

PR-URL: #5201

Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: update removeListener behaviour vaibhav93/node
3 participants
@drjokepu @Fishrock123 @cjihrig