How to document a returned event emitter

Question

How to document events emitted by stream returned to MyFunc() using JSDoc?

 /** * [MyFunc description] * @param {Object} opts - [description] * @return {Stream} - [description] */ function MyFunc (opts) { // stream is an EventEmitter var stream = new MyEventEmitter(); stream.emit('event1', ... ); stream.emit('event2', ... ); return stream; } 

Answer 1

You can document this behavior by documenting your events ( event1 , event2 , ...) as @event MyFunc#event1 and MyFunc, or whoever @fires MyFunc#event1 , with @fires MyFunc#event1 .

You can also document the functions that listen to these events using @listens MyFunc#event:event1 .

Here are the official JSDoc pages for the above tags:

• https://jsdoc.app/tags-event.html
• https://jsdoc.app/tags-fires.html
• https://jsdoc.app/tags-listens.html

Pay attention to some nuance around the "event" mentioned on the tag event page, repeating here:

JSDoc automatically adds event: namespaces to each event name. In general, you should include this namespace when referencing an event in another report. (The @fires tag is a notable exception; it allows you to skip the namespace.)