jsdoc-如何将Express.js请求和响应用作参数类型

Question

我有一个函数以Express Request和Response对象作为参数。

function doStuff(req, res) {
  // do something
}

如何使用jsdoc记录req和res的类型？

编辑：我觉得这不是重复的原因是我在问如何专门将Express类用作类型，而其他问题则建议将其记录为Object，然后记录属性< / p>

Answer 1

您不仅可以使用JsDoc的参数类型和描述，还可以使用它们的预期成员。

/**
 * 
 * @module doStuff
 * @function
 * @param req {Object} The request.
 * @param res {Object} The response.
 * @param req.params.foo {String} The foo param.
 * @param req.query.bar {String} The bar query.
 * @param req.body {Object} The JSON payload.
 * @param {Function} next
 * @return {undefined}
 */
function doStuff(req, res, next){
}