@event

Содержание

• Синтаксис
• Обзор
• Примеры
• Связанные ссылки

Синтаксис

@event <className>#[event:]<eventName>

Обзор

Тег @event позволяет документировать событие, которое может быть сгенерировано. Типичное событие представлено объектом с определённым набором свойств.

После использования тега @event для определения определённого типа события, вы можете использовать тег @fires для указания, что метод может генерировать это событие. Также вы можете использовать тег @listens для указания, что символ прослушивает это событие.

JSDoc автоматически добавляет префикс event: к имени каждого события. В общем случае, вы должны указать этот префикс, когда вы ссылаетесь на событие в другом документе. (Тег @fires является заметным исключением; он позволяет опустить префикс.)

Примечание: JSDoc 3 использует doclets @event для документирования содержимого события. В отличие от этого, JSDoc Toolkit 2 использовал doclets @event для идентификации функции, которая может быть вызвана, когда происходит событие с таким же именем.

Примеры

В следующих примерах показано, как документировать событие в классе Hurl с именем snowball. Событие содержит объект с одним свойством.

/**
 * Throw a snowball.
 *
 * @fires Hurl#snowball
 */
Hurl.prototype.snowball = function() {
    /**
     * Snowball event.
     *
     * @event Hurl#snowball
     * @type {object}
     * @property {boolean} isPacked - Indicates whether the snowball is tightly packed.
     */
    this.emit('snowball', {
        isPacked: this._snowball.isPacked
    });
};

/**
 * Throw a snowball.
 *
 * @fires Hurl#snowball
 */
Hurl.prototype.snowball = function() {
    // ...
};

/**
 * Snowball event.
 *
 * @event Hurl#snowball
 * @type {object}
 * @property {boolean} isPacked - Indicates whether the snowball is tightly packed.
 */

Связанные ссылки

• @fires
• @listens