JSDoc:根据另一个参数使参数成为必需/可选

时间:2019-03-14 01:01:27

标签: jsdoc jsdoc3

我有两个参数,limitpage。如果传递了page,则需要limit。否则,limit是可选的。以下是我当前的JSDoc。我如何修改它(如果可能)以正确显示两者之间的关系?

/**
 * ...
 * @param {Number} [ctx.request.body.limit] A limit on the number of items to return
 * @param {Number} [ctx.request.body.page] The page we are currently on. A `limit` must also be
 *                                         given when using this parameter
 */

0 个答案:

没有答案