@eventProperty
タグ タイプ: 修飾子
TSDoc 標準化: 拡張
クラスまたはインターフェイスのプロパティに適用されるとき、プロパティは、イベントハンドラがアタッチできるイベントオブジェクトを返すことを示します。イベント処理 API は実装によって定義されますが、通常、プロパティの戻り値タイプは、addHandler() および removeHandler() などのメンバーを持つクラスです。ドキュメント化ツールは、このようなプロパティを通常の「プロパティ」見出しではなく「イベント」見出しの下に表示できます。
使用例
/**
* @public
*/
export class Button {
/**
* This event is fired whenever the button is clicked.
* @eventProperty
*/
public get clicked(): Event {
. . .
}
}