使用可选的第一个参数记录 JavaScript

Question

我正在尝试记录其中一个在 JavaScript 中具有可选 first 参数的烦人函数。

类似于express 中的函数.use()

function use(path, callback) // path is optional

我正在尝试找到一些可行的方法，并且最好不要太丑。

我对实际代码签名的偏好是这样的：

function use(...args) {
  const [callback, path] = args.reverse();
}

在这种情况下，我没有两个参数，所以如果我尝试使用两个 @param 行，我会在 JSDoc 块中被骂：

/**
 * @param {String=} path
 * @param {Function} callback
 */
function use(...args) // mismatched parameters

如果我按预期使用参数并使用不同的模式来放置参数，我会被（WebStorm）大喊大叫，因为callback 不是String：

/**
 * @param {String=} path
 * @param {Function} callback
 */
function use(path, callback) {
  if (typeof path == 'function') {
    callback = path; // yelled at because callback can't be a string
    path = undefined;
  }
}

我用谷歌搜索了很多旧的东西，不同的人在争论这个问题，但没有明确的答案。由于帖子较旧并且发生了很多事情，我想重新问一下：有没有办法记录这一点，所以一切都很愉快（至少在 WebStorm 中），或者是否有一些新的 ES# 语法允许可选的第一个参数（可以生成正确的自动完成）？

Answer 1

@param {(String=|Function=)} path

可能是您正在寻找的。