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

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

eventemitter jsdoc javascript

7

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 年前

1

3

gp. 5 年前

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

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

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

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

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

推荐文章

Softly · 单选按钮未按预期取值

1 年前

Jason Owens · 我的html/javascript播放按钮无法播放嵌入的youtube视频

1 年前

SlickRed · 我无法使用JS关注HTML元素

1 年前

Mayron Guedes · 如果登录名不在本地存储中,如何重定向页面?

1 年前

assembler · Nextjs没有处理发布请求

1 年前

PavelB · 如何使用Seleniumwebdriver和mocha只运行一个测试文件?

1 年前

BADRUM · 执行两个获取功能后,如何导航回页面?

1 年前

Toniq · javascript为php保存多维数组

1 年前

Natalie Smyth · 隐藏类只在我试图切换的两个部分中的一个部分上工作

1 年前

SkyWalker · 在JavaScript中,合并日期-时间序列的有效算法是什么?

1 年前

关于移动版

代码之家 - 一站式码农服务社区

沪ICP备11025650号