Где я могу хранить информацию JSDoc typedef для обмена между проектами?

Question

Я добавляю @typedef комментарии JSDoc в начало файлов Javascript, чтобы помочь определить типы (на самом деле, чтобы я мог воспользоваться некоторыми преимуществами машинописного текста, не изучая все это сегодня).

Где я могу хранить информацию JSDoc typedef для обмена между проектами в VSCode?

Например, могу ли я сохранить это в каком-то внешнем файле, а затем использовать его в нескольких .js файлах?

/**
 * @typedef {Object} SomeType
 * @property {String} id
 */

Answer 1

Вы можете поместить этот фрагмент кода в файл .js, а затем либо добавить его в files или include в каждом файле tsconfig.json, либо использовать справочную директиву:

///<reference path="path/to/shared-file.js" />

(Это те же две опции, которые у вас есть для файлов объявлений TypeScript.) Это становится немного сложнее, если ваш общий файл является модулем ES6 (с импортом или экспортом ES6 верхнего уровня); тогда вам нужно будет либо импортировать его, либо использовать типы импорта .