Repository navigation
Improve EventEmitter documentation #4554
Description
Currently:
emitter.listenerCount(type)
type Value The type of eventemitter.listeners(event)
Returns a copy of the array of listeners for the specified event.
In both cases, type and event arguments refer to the "event name", so I suggest calling both "type".
Activity
targos commentedon Jan 6, 2016
+1 for consistency but I would go with
eventbecause it's the name used for the other methods (addListener, emit, ...).Would you mind creating a PR to address this ?
ibc commentedon Jan 6, 2016
Wow, I've forked the project and it found that it already uses
eventinstead oftype... :)However I've sent a PR improving it a bit.
chrisdickinson commentedon Jan 6, 2016
I've been leaning towards the term "topic" since "event" can mean both the name of the event and the actual occurrence of the event.
mscdex commentedon Jan 6, 2016
"topic" to me sounds like something that involves a 2+-way conversation or something, when in this case it's a one-way thing. Maybe just use "event name?"
sam-github commentedon Jan 6, 2016
fwiw, "event name" in text makes sense to me,
eventin the API signature makes more sense to me:Seems symmetrical and consistent - we call it the exit event, and we set the event argument to the string 'exit'. "topic" is just a word that doesn't show anywhere else in conversation about the event emitter or docs, so doesn't seem to help a lot (to me).
ibc commentedon Jan 6, 2016
The DOM exposes a Event class/object to the user, but Node's
EventEmitterdoes not. InsteadEventEmitterjust mentions:listener(a function callback)event(the name of the event)Nothing else. And since there is no "Event" object at all it is 100% safe to use
eventas a simple string, because there is not anything else in the API.ryansobol commentedon Jan 9, 2016
+1 for
event. It seems pretty harmless to change it in the future if anEventclass/object is ever added to the API.doc: use consistent event name parameter
doc: use consistent event name parameter
doc: use consistent event name parameter
doc: use consistent event name parameter
jasnell commentedon Apr 22, 2016
This can be closed. The documentation has been updated to use
eventNameconsistently