@eventProperty
标签类型:修饰符
TSDoc 标准化: 扩展
当应用于类或接口属性时,这表示属性返回一个事件对象,事件处理程序可以附加到该对象。事件处理 API 是实现定义的,但通常属性返回类型将是一个类,其中包含诸如 addHandler()
和 removeHandler()
之类的成员。文档工具可以在“事件”标题下显示此类属性,而不是通常的“属性”标题。
使用示例
/**
* @public
*/
export class Button {
/**
* This event is fired whenever the button is clicked.
* @eventProperty
*/
public get clicked(): Event {
. . .
}
}