jsdoc дефис в ключе объекта - PullRequest
Новая
       40

jsdoc дефис в ключе объекта

0 голосов
/ 28 декабря 2018

Объект возвращается из API, который содержит дефис.У меня возникли проблемы с документированием этого с JSDoc в VS Code.В VS Code JSDoc дефис и все, что находится после дефиса, игнорируется.Я тоже пробовал Object.<string, string>. 

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

1 Ответ

0 голосов
/ 24 января 2019

Решено с помощью объявлений TypeScript и директивы triple slash .

Поскольку я не использую TypeScript в проекте, я сделал следующее:

  1. Создайте папку для типов
  2. Добавьте директиву тройной косой черты в файл JavaScript.Пример: <reference path="./types/my-model.d.ts" /> или используйте jsconfig.json
...