TypeScript na JSDoc komentáre
Premeniete TypeScript typy funkcií a rozhraní na JSDoc komentáre, aby si typy zachovali aj v čistom JavaScripte.
TypeScript na JSDoc komentáre
Vložte TypeScript funkciu, arrow funkciu, rozhranie alebo alias typu a tento nástroj napíše vyhovujúci JSDoc komentár — `@param` pre každý parameter, `@returns` pre návratový typ a `@typedef` s `@property` riadkami pre rozhrania a alias typov. Je určený na presunutie kódu z `.ts` do obyčajného `.js` bez straty informácií o typoch, ktoré editor alebo JSDoc-kompatibilný linter stále potrebuje.
"Odstrániť TypeScript anotácie" odstráni syntax typov zo signatúry — typy parametrov, návratové typy, listy generických parametrov — a nechá platný JavaScript s tou istou informáciou v komentári; vypnite to, ak chcete zachovať TypeScript bez zmien a len pridať dokumentáciu. "Generovať @typedef pre rozhrania" zmení `interface` alebo objekt `type` na blok typedef; "Pridať @template pre generiky" dokumentuje parametre typu ako `<T>`; "Pridať @throws z príkazov throw" skúma telo každej funkcie pre `throw new SomeError(...)` a vymenuje nájdené typy chýb. Štýl komentáru sa prepína medzi konvenčným blokom so zarovnanými hviezdami a kompaktnejšou variantou s otvorením na jednom riadku, a šírka riadku kontroluje, kde sa dlhý riadok zalomí.
Nástroj číta deklarácie funkcií na najvyššej úrovni, arrow funkcie priradené `const` alebo `let`, rozhrania a alias typov s formou objektu — deklarácie, pre ktoré má JSDoc tag. Anotácie typov na lokálnych premenných v tele funkcie a metódy definované v triede alebo objekte sú ponechané bez zmien; bezpečné prepísanie každého typu v súbore vyžaduje kompletný kompilátor a tento nástroj zostáva malý a rýchly skript, ktorý sa spúšťa v momente, keď prestanete písať.
Všetko sa spúšťa lokálne vo vašom prehliadači — váš kód nikdy nie je nahrávaný, takže vloženie z privátneho projektu je bezpečné. Skopírujte výsledok, stiahnite ho ako .txt súbor alebo pošlite výstup priamo späť do vstupu a spustite ďalší nástroj.