Skip to main content

@external

Syntax​

@external name

Overview​

@external documents a type or class that is defined outside of the current codebase — for example, a class from a third-party library or a built-in JavaScript type. Once documented, you can link to it with {@link external:Name}.

Example​

/**
 * The built-in string object.
 * @external String
 * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String MDN String}
 */

/**
 * Returns the string in uppercase.
 * @function external:String#toUpperCaseCustom
 * @returns {string}
 */
String.prototype.toUpperCaseCustom = function () {
  return this.toUpperCase();
};

See also​

Official reference: jsdoc.app/tags-external