对象键中的 JSDOC 连字符

Question

一个

对象是从包含连字符的API返回的。我在 VS Code 中使用 JSDoc 记录此内容时遇到问题。在 VS Code JSDoc 中，连字符和连字符之后的所有内容都被忽略。我也试过Object.<string, string>。

/**
 * @typedef MyAPIResponse
 * @type {object}
 *
 * @property {string} X-Request-Id
 * @property {string} X-Correlation-Id
 */

Answer 1

通过使用 TypeScript 声明和三斜杠指令解决。

由于我没有在项目中使用 TypeScript，因此我执行以下操作：

1. 为类型创建文件夹
2. 将三斜杠指令添加到 JavaScript 文件。示例：<reference path="./types/my-model.d.ts" />或使用jsconfig.json