javascript - 如何记录返回的事件发射器

Question

如何使用 JSDoc 记录在 MyFunc() 中返回的 stream 发出的事件？

/**
 * [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

您可以通过将事件(event1、event2、...)记录为 @event MyFunc#event1 和 MyFunc 来记录这些行为，或者任何发出信号的人，使用 @fires MyFunc#event1。

您还可以使用 @listens MyFunc#event:event1 记录监听这些事件的函数。

以下是上述标签的官方 JSDoc 页面:

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

请注意标签事件页面中提到的“事件”的一些细微差别，在此处重复:

JSDoc automatically prepends the namespace event: to each event's name. In general, you must include this namespace when you link to the event in another doclet. (The @fires tag is a notable exception; it allows you to omit the namespace.)