如何使用 JSDoc 注释 Express 中间件？

Question

我正在尝试记录一个 Express 中间件，但是 WebStorm 中的内置验证工具告诉我在以下 JSDoc 块中错误地分配了类型：

 /**
 * My middleware.
 *
 * @param {Object} req
 * @param {Object} res
 * @param {Function} next
 * @return {Object}
 */
exports.show = function(req, res, next) {
    ...
};

在 Express 资源中，我没有找到任何 @typedef 来帮助我。另外，我想避免像 @param {*} 这样的事情。

使用 JSDoc 记录 Express 中间件的正确方法是什么？谢谢你的帮助。

原文由 Jun Thong 发布，翻译遵循 CC BY-SA 4.0 许可协议

Answer 1

使用 DefinitelyTyped

1. 安装快递类型 npm install --save-dev @types/express
2. 像往常一样使用 e.Response @param {e.Response} res

更多类型

• 在文件中 /node_modules/@types/express/index.d.ts
• 对于 Response 它是 e.Response 因为：

... declare namespace e { ... export interface Response extends core.Response { } ...

网络风暴

通过 Settings > Languages & Frameworks > Javascript > Libraries > @types/express 安装类型

原文由 Michal Miky Jankovský 发布，翻译遵循 CC BY-SA 4.0 许可协议