TypeScript till JSDoc-kommentarer
Omvandla TypeScript-funktions- och gränssnittstyper till JSDoc-kommentarer så att typerna bevaras i vanlig JavaScript.
TypeScript till JSDoc-kommentarer
Klistra in en TypeScript-funktion, pillfunktion, gränssnitt eller typelias, och det här verktyget skriver motsvarande JSDoc-kommentar ovanför den — `@param` för varje parameter, `@returns` för returtypen och `@typedef` med `@property`-rader för objektformade gränssnitt och typaliasser. Det är byggd för att flytta kod från `.ts` till vanlig `.js` utan att förlora den typinformation som en redaktör eller en JSDoc-medveten linter fortfarande behöver.
"Ta bort TypeScript-annotationer" tar bort typsyntaxen från själva signaturen — parametertyper, returtyper, generiska parameterlister — vilket gör att giltig JavaScript kvarstår med samma information som nu finns i kommentaren. Stäng av det här alternativet för att hålla TypeScript oförändrad och bara lägga till dokumentation ovanpå det. "Generera @typedef för interfaces" omvandlar ett `interface` eller en objektformad `type` till ett typedef-block. "Lägg till @template för generics" dokumenterar typparametrar som `<T>`; "Lägg till @throws från throw-satser" skannar funktionens brödtext efter `throw new SomeError(...)` och listar de olika feltyper som hittades. Kommentarsstil växlar mellan det konventionella justerade-stjärnor-blocket och en stramare en-rad-öppen variant, och radbredd styr var en lång rad radbrytes.
Verktyget läser funktiondeklarationer på översta nivå, pillfunktioner tilldelade en `const` eller `let`, gränssnitt och objektformade typaliasser — de deklarationer som JSDoc har en tagg för. Typannotationer på lokala variabler inuti funktionens brödtext och metoder som definieras i en klass eller objektliteral lämnas oförändrade. Det är säkert att skriva om alla typer i en fil kräver en fullständig kompilator, och detta förblir ett litet, snabbt skript som körs i det ögonblick du slutar skriva.
Allt körs lokalt i din webbläsare — din kod laddas aldrig upp, så inklistring från ett privat projekt är säkert. Kopiera resultatet, ladda ned det som en .txt-fil eller skicka utdata direkt tillbaka till indata för att köra ett annat verktyg på det.