@async

Содержание

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

Синтаксис

@async

Обзор

Тег @async указывает, что функция является асинхронной, что означает, что она была объявлена с помощью синтаксиса async function foo() {}. Не используйте этот тег для других типов асинхронных функций, таких как функции, которые предоставляют обратный вызов. Этот тег доступен в JSDoc 3.5.0 и более поздних версиях.

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

Пример

Следующий пример демонстрирует виртуальный комментарий, использующий тег @async:

/**
 * Download data from the specified URL.
 *
 * @async
 * @function downloadData
 * @param {string} url - The URL to download from.
 * @return {Promise<string>} The data from the URL.
 */