@event

Tag Kind

Modifier

TSDoc Reference

TypeDoc specific

The @event tag is used to mark a reflection as belonging in the "Events" group. It is equivalent to specifying @group Events in the comment.

Example

export class App extends EventEmitter {
    /**
     * @event
     */
    static ON_REQUEST = "request";
}

See Also

• The @group tag
• The @eventProperty tag