【问题标题】:How to validate / check types using JSDoc?如何使用 JSDoc 验证/检查类型?
【发布时间】:2020-03-12 17:18:43
【问题描述】:

我正在寻找类似 ESLint 的东西,但它实际上会根据 JSDoc @param 标签验证类型。我试过,但它似乎没有强制执行。例如这不会抛出:

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

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

【问题讨论】:

标签: ts-node javascript node.js eslint jsdoc


【解决方案1】:

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

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

如您所见,它能够从 JSDoc @param 标记推断出 add 函数被调用时使用了意外的参数类型:

【讨论】:

    【解决方案2】:

    您可以使用 typescript 检查 javascript 文件中的类型。您必须使用 tsconfig 文件并将“checkJS”标志设为真。 https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html

    【讨论】:

      猜你喜欢
      • 2014-04-08
      • 1970-01-01
      • 2015-05-16
      • 1970-01-01
      • 2021-04-17
      • 1970-01-01
      • 2022-01-18
      • 2020-04-17
      • 2023-03-31
      相关资源
      最近更新 更多