doc: missing argument types for events methods #11802
Closed
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
nodejs-github-bot
added
doc
mscdex
reviewed
Mar 11, 2017
doc/api/events.md
Outdated
|
|
||
| Alias for `emitter.on(eventName, listener)`. | ||
|
|
||
| ### emitter.emit(eventName[, ...args]) | ||
| <!-- YAML | ||
| added: v0.1.26 | ||
| --> | ||
| - `eventName` {string|symbol} | ||
| - `...args` {Function[]} |
There was a problem hiding this comment.
The type here isn't correct. It can be zero or more of any kind of values. I'm not sure if we've yet "standardized" on what term to use as an 'any' type.
mscdex
reviewed
Mar 11, 2017
doc/api/events.md
Outdated
| @@ -296,13 +296,17 @@ Its `name` property is set to `'MaxListenersExceededWarning'`. | |||
| <!-- YAML | |||
| added: v0.1.26 | |||
| --> | |||
| - `eventName` {string|symbol} | |||
There was a problem hiding this comment.
We're more lax than this. We basically accept any value, it's just that (currently) it will be converted to a string before being used. So for example numbers, booleans, functions (the function's source will be used as the event name), etc. all work.
mscdex
reviewed
Mar 11, 2017
doc/api/events.md
Outdated
| @@ -564,6 +572,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained. | |||
| <!-- YAML | |||
| added: v0.3.5 | |||
| --> | |||
| - `n` {number} | |||
There was a problem hiding this comment.
I think it may make more sense to be more specific here and say 'integer.'
ameliavoncat
force-pushed
the
events-argument-types
branch
from
81c7f32
to
f581702
Compare
jasnell
approved these changes
Mar 12, 2017
|
LGTM |
cjihrig
approved these changes
Mar 12, 2017
jasnell
pushed a commit
that referenced
this pull request
Mar 15, 2017
Refs: #9399 PR-URL: #11802 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Brian White <[email protected]>
|
Landed in 38ba0c2. Thank you! :-) |
italoacasas
pushed a commit
to italoacasas/node
that referenced
this pull request
Mar 20, 2017
Refs: nodejs#9399 PR-URL: nodejs#11802 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Brian White <[email protected]>
jungx098
pushed a commit
to jungx098/node
that referenced
this pull request
Mar 21, 2017
Refs: nodejs#9399 PR-URL: nodejs#11802 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Brian White <[email protected]>
|
This does not land cleanly in LTS. Please feel free to manually backport. Please also feel free to replace the backport request label with do-not-land if it shouldn't land |
This was referenced Mar 7, 2020
This was referenced Nov 30, 2023
This was referenced Nov 30, 2023
This was referenced Dec 1, 2023
This was referenced Dec 1, 2023
This was referenced Dec 1, 2023
This was referenced Dec 2, 2023
This was referenced Dec 2, 2023
This was referenced Dec 2, 2023
This was referenced Dec 2, 2023
This was referenced Dec 3, 2023
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.
Checklist
Affected core subsystem(s)
documentation
Description of changes
Adds missing argument types to the docs for
eventmethodsIssue