@requires

Syntax

@requires moduleName

Overview

@requires documents that a file or symbol has a runtime dependency on another module. It is primarily informational — it does not affect how JSDoc generates the documentation.

Example

/**
 * @file HTTP utilities.
 * @requires http
 * @requires url
 */
const http = require('http');
const url = require('url');

See also

• @module
• @file

Official reference: jsdoc.app/tags-requires