如何在 JSDoc 中使用 Function 类型注释 object 类型，该类型具有可变数量的 arguments？

Question

我得到以下代码：

/**
 * @type {function(boolean, string, ...*):void}
 */
exports.warn = createMacro(macro)

warn是一个 function，其签名为 (arg1, arg2, ...arg3)。 当我尝试在其他地方使用此方法时，WebStorm 和 VSCode 抱怨说，需要第三个参数而不是可选的

根据此注释生成.d.ts文件时，签名是正确的： arg0: boolean, arg1: string, ...args: any[]如何修改注释以便 IDE 不会抱怨缺少参数？

Answer 1

通过使用 @type 的内联 function 定义，我找不到解决go问题的方法。 但是，有几个替代方案有一些缺点，您可以考虑。

第一种方式使用 JSDoc 语法，并且应该与任何读取它的工具兼容。 我首先声明了一个@callback function 类型，然后将变量的类型设置为它。 通过将最后一个参数名称括在括号中，该参数将变为可选，并且应该可以清除您的错误。

/**
 * @callback WarnFunc
 * @param {boolean} arg1
 * @param {string} arg2
 * @param {...*} [restParam]
 * @returns void
 */
/** @type WarnFunc*/
exports.warn = createMacro(macro);

上面的问题是它比你以前的要冗长得多。 TypeScript 支持在 TypeScript 语法和 JSDoc 中定义的类型参数。 因此，如果维护 JSDoc 的语法不是优先事项，那么以下方式应该可以工作并且更简洁：

/**
 * @type {(arg1: boolean, arg2: string, ...restArgs: string[]) => void}
 */
exports.warn = createMacro(macro);

当我这样做时，我没有收到任何错误，但restArgs参数也没有显示为可选。 因此，如果您仍有问题，可以明确地将 rest 参数设为可选。 当我尝试它时它似乎工作，虽然它不是有效的 TypeScript 语法。

@type {(arg1: boolean, arg2: string, ...restArgs?: string[]) => void}