TypeScript у коментарі JSDoc
Перетворіть типи функцій та інтерфейсів TypeScript у коментарі JSDoc, щоб типи збереглися у простому JavaScript.
TypeScript у коментарі JSDoc
Вставте функцію TypeScript, стрілкову функцію, інтерфейс або псевдонім типу, і цей інструмент напише відповідний коментар JSDoc над нею — `@param` для кожного параметра, `@returns` для типу повернення та `@typedef` з рядками `@property` для інтерфейсів та псевдонімів типів об'єктної форми. Він призначений для перенесення коду з `.ts` у звичайний `.js` без втрати інформації про типи, яка знадобиться редакторові або linter, що підтримує JSDoc.
"Видаляти анотації TypeScript" вилучає синтаксис типів із самої сигнатури — типи параметрів, типи повернення, списки параметрів узагальнень — залишаючи коректний JavaScript із тією ж інформацією, яка тепер знаходиться у коментарі; вимкніть його, щоб залишити TypeScript без змін і просто додати документацію зверху. "Генерувати @typedef для інтерфейсів" перетворює `interface` або об'єктний `type` у блок typedef; "Додавати @template для узагальнень" документує параметри типів на кшталт `<T>`; "Додавати @throws з операторів throw" сканує тіло кожної функції на `throw new SomeError(...)` та перелічує знайдені різні типи помилок. Стиль коментаря перемикається між традиційним блоком із вирівняними зірочками та компактнішим варіантом із відкриваючою зірочкою в один рядок, а ширина рядка керує переносом довгих рядків.
Інструмент читає оголошення функцій верхнього рівня, стрілкові функції, призначені `const` або `let`, інтерфейси та псевдоніми типів об'єктної форми — оголошення, для яких JSDoc має тег. Анотації типів на локальних змінних усередині тіла функції та методи, визначені всередині класу або літерала об'єкту, залишаються як написано; безпечне переписування кожного типу у файлі вимагає повного компілятора, і цей інструмент залишається невеликим, швидким скриптом, що працює в момент припинення введення тексту.
Все працює локально у вашому браузері — ваш код ніколи не завантажується, тому вставлення коду з приватного проекту безпечно. Скопіюйте результат, завантажте його як файл .txt або відправте вихід прямо назад на вхід, щоб запустити на ньому інший інструмент.