TypeScript u JSDoc komentare
Pretvori tipe TypeScript funkcija i sučelja u JSDoc komentare kako bi se tipovi sačuvali u običnom JavaScriptu.
TypeScript u JSDoc komentare
Zalijepite TypeScript funkciju, arrow funkciju, sučelje ili alias tipa i ovaj alat ispisuje odgovarajući JSDoc komentar iznad njega — `@param` za svaki parametar, `@returns` za tip povratne vrijednosti, i `@typedef` s `@property` linijama za sučelja i type aliase oblika objekta. Napravljen je za premještanje koda iz `.ts` u običan `.js` bez gubitka informacija o tipovima koje editor ili JSDoc-svjesna linter i dalje trebaju.
"Ukloni TypeScript adnotacije" uklanja tip sintaksu iz samog potpisa — tipove parametara, povratne tipove, liste generičkih parametara — ostavljajući validan JavaScript s istim informacijama koje sada žive u komentaru; isključite ga kako biste zadržali TypeScript nepromijenjen i samo dodali dokumentaciju na vrh. "Generiraj @typedef za sučelja" pretvara `interface` ili tip objekta `type` u blok typedef; "Dodaj @template za generike" dokumentira tipske parametre poput `<T>`; "Dodaj @throws iz throw iskaza" skenira tijelo svake funkcije za `throw new SomeError(...)` i navodi pronađene različite tipove grešaka. Stil komentara prebacuje se između konvencionalnog bloka s poravnatim zvjezdama i komaktnije one-line-open varijante, a širina linije kontrolira gdje se duga linija prelama.
Alat čita deklaracije funkcija na vrhu razine, arrow funkcije dodijeljen `const` ili `let`, sučelja i type aliase oblika objekta — deklaracije za koje JSDoc ima tag. Adnotacije tipa na lokalnim varijablama unutar tijela funkcije, i metode definirane unutar klase ili objektnog literala, ostaju kako su napisane; repisivanje svakog tipa u datoteci sigurno trebam punog compilera, a ovo ostaje mali, brz skripti koji se pokreće čim prestanete pisati.
Sve se izvršava lokalno u vašem pregledniku — vaš kod se nikada ne učitava, tako da je lijepljenje koda iz privatnog projekta sigurno. Kopirajte rezultat, preuzmite ga kao .txt datoteku, ili pošaljite izlaz direktno natrag u ulaz kako biste pokrenuli drugi alat na njega zatim.