如何使用JSDoc验证/检查类型?

时间:2019-11-16 22:44:16

标签: javascript node.js eslint jsdoc

我正在寻找类似ESLint的东西,但实际上可以验证基于JSDoc @param标签的类型。我尝试了,但似乎没有执行它。例如,这不会抛出:

/**
 * Adds
 * 
 * @param {number} numb1
 * @param {number} numb2
 * 
 * @returns {number}
 */
function add(numb1, numb2) {
  return numb1 + numb2
}

console.log(add('something', '234'))

2 个答案:

答案 0 :(得分:2)

根据我的评论并根据您的项目配置,您可以为此使用Google Closure Compiler

有一个在线游乐场,人们可以在上面玩耍。这是编译器在尝试打开高级优化的情况下尝试编译代码时所说的话。

如您所见,已经可以从JSDoc @param标记推断出add函数是用意外的参数类型调用的:

enter image description here

答案 1 :(得分:0)

您可以使用打字稿检查JavaScript文件中的类型。您必须使用tsconfig文件并将'checkJS'标志设为true。 https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html