@async

Syntax

@async

Overview

@async marks a function as asynchronous. JSDoc detects async function syntax automatically, so this tag is mainly useful for documentation consistency or when using non-standard async patterns.

Example

/**
 * @async
 * @param {string} url
 * @returns {Promise<Response>}
 */
async function fetchData(url) {
  return fetch(url);
}

See also

• @generator
• @returns

Official reference: jsdoc.app/tags-async