代码之家 › 专栏 › 技术社区 › leesei

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

eventemitter jsdoc javascript

leesei · 技术社区 · 9 年前

如何记录由 stream 返回 MyFunc() 使用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;
}

1 回复 | 直到 9 年前

gp. 6 年前

您可以通过记录事件来记录这些行为( event1 , event2 ,…)作为 @event MyFunc#event1 和MyFunc,或是谁发射的 @fires MyFunc#event1 .

您还可以用文档记录侦听这些事件的函数 @listens MyFunc#event:event1 .

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

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

JSDoc自动在命名空间前面 event: 每个事件的名称。通常,当您链接到另一个doclet中的事件时,必须包含此命名空间。( @fires 标记是 显著例外 ; 它允许您省略名称空间。)

推荐文章

Mr.C · 如何对节点中使用承诺和事件发射器的函数进行单元测试。js?

7 年前

Saad · 在使用流扩展EventEmitter的类中限制“eventName”的类型?

7 年前

m.mikolajczak · 向节点服务器上的一个EventEmitter添加多个侦听器

7 年前

Marco24690 · 角度2向应用程序根组件发射事件

7 年前

Abhishek Yadav · 如何在另一个模块中要求一个模块来使用事件发射器?

7 年前

Kerim092 · EventEmitters如何跟踪上传进度?价值变化?

7 年前

user4422315 · 角度4-从父组件到子组件的事件绑定

7 年前

DaveC426913 · 角度2:使用服务广播事件

7 年前

metis · nodejs中的事件发射器和nexttick

8 年前

Pardeep Jain · EventEmitter无法使用引导模式解析正确的参数

9 年前