@callback

Содержание

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

Синтаксис

@callback <namepath>

Обзор

Тег @callback предоставляет информацию о функции обратного вызова, которая может быть передана другим функциям, включая параметры и возвращаемое значение обратного вызова. Вы можете использовать любые теги, которые вы можете использовать для @method.

После определения обратного вызова вы можете использовать его так же, как пользовательский тип, определённый тегом @typedef. В частности, вы можете использовать имя обратного вызова как имя типа. Это позволяет указать, что параметр функции должен содержать определённый тип обратного вызова.

Если вы хотите, чтобы обратный вызов отображался с определениями типов для конкретного класса, вы можете указать обратный вызов с путем, указывающим, что это внутренняя функция этого класса. Вы также можете определить глобальный тип обратного вызова, к которому обращаются из нескольких классов.

Примеры

/**
 * @class
 */
function Requester() {}

/**
 * Send a request.
 * @param {Requester~requestCallback} cb - The callback that handles the response.
 */
Requester.prototype.send = function(cb) {
    // code
};

/**
 * This callback is displayed as part of the Requester class.
 * @callback Requester~requestCallback
 * @param {number} responseCode
 * @param {string} responseMessage
 */

/**
 * @class
 */
function Requester() {}

/**
 * Send a request.
 * @param {requestCallback} cb - The callback that handles the response.
 */
Requester.prototype.send = function(cb) {
    // code
};

/**
 * This callback is displayed as a global member.
 * @callback requestCallback
 * @param {number} responseCode
 * @param {string} responseMessage
 */

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

• @function
• @typedef