用于运行时验证的 JSDoc 类型

Question

我们目前正在考虑将具有类型/类型安全性的 JSDoc 添加到我们的项目中。与 Typescript 相比，我们更喜欢带有类型的 JSDoc，因为我们编写的主要是自包含函数，并且不希望工具链中存在 Typscript 的开销。我们还有带有传入参数的 REST 端点。我们也想验证这些 - 例如使用 ajv，但我们不想将类型写入两次（在验证器和 JSDoc 中）。避免重蹈覆辙的最佳选择是什么？我们知道 JSDoc 只是注释，很难解释任何内容。

• NestJS 有一个有趣的方法，但也使用 TypeScript (https://docs.nestjs.com/techniques/validation)
• 一个想法是让它自动生成（不知道如何以实际的方式做到这一点）并且仍然将它放在两个地方。但这样的话还是需要改两个地方。

Answer 1

你找到解决办法了吗？ 我发现https://github.com/brettz9/jsdoc-jsonschema，它可以从jsdoc生成json schema

我正在寻找完整的解决方案（可能在应用程序启动时生成 json 模式或使用模式缓存）