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

Question

如何记录JSDoc stream返回的事件MyFunc()？

/**
 * [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、 ...）记录为 和 MyFunc 来记录这些行为@event MyFunc#event1，或者使用 来记录这些行为@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 自动将命名空间添加event:到每个事件的名称前面。通常，当链接到另一个 doclet 中的事件时，必须包含此命名空间。（@fires标签是一个值得注意的例外；它允许您省略名称空间。）