Schulung · Workshop · Coaching · Beratung

JSDoc und TypeScript Workshop: typgeprüftes JavaScript ohne Build

JSDoc und TypeScript: typgeprüftes JavaScript ohne Build-Schritt

Dauer: ab 1 Tag | Preis: ab 900 EUR (Netto) | Termin: Ganztägig + halbtägig

Ihr Code bleibt JavaScript, wird aber vom TypeScript-Compiler geprüft: Sie annotieren Typen mit JSDoc, liefern Bibliotheken mit .d.ts-Dateien aus und erzeugen daraus eine API-Dokumentation.

Typsicherheit für JavaScript-Projekte, die keine .ts-Dateien wollen

Mit JSDoc und TypeScript bekommen JavaScript-Projekte eine echte Typprüfung, ohne dass eine einzige Datei umbenannt oder ein Übersetzungsschritt eingeführt wird. Die Typen stehen in Kommentaren wie @param, @typedef und @template; der TypeScript-Compiler liest sie mit checkJs und meldet Fehler im Editor und in der CI. Der Code, der ausgeliefert wird, ist genau der Code, den Sie geschrieben haben – ein Grund, warum Bibliotheken wie Svelte und Werkzeuge mit vielen Mitwirkenden diesen Weg gewählt haben.

Wir beginnen mit // @ts-check und einer jsconfig.json bzw. tsconfig.json, typisieren dann Funktionen, Klassen und Callbacks und arbeiten uns zu Generics, Typwächtern und Utility-Typen in JSDoc-Syntax vor. Komplexe Typen lagern Sie in .d.ts-Dateien aus und binden sie per @import ein. Für Bibliotheksautor:innen folgt die Auslieferung: Deklarationsdateien aus den Kommentaren erzeugen, exports in der package.json korrekt setzen und prüfen, ob die Typen bei Nutzer:innen ankommen.

Aus denselben Kommentaren entsteht die Dokumentation. Sie erzeugen eine API-Website mit dem klassischen JSDoc-Generator samt Theme und Markdown-Seiten und lernen TypeDoc als Alternative kennen, die TypeScript-Typsyntax vollständig versteht und auch Markdown für Wiki oder Repository ausgeben kann. REST-Endpunkte und README runden die Projektdokumentation ab.

JSDoc-Pflege ist eine Aufgabe, die Coding-Agenten gut beherrschen, wenn die Leitplanken stimmen. In WebStorm übernimmt das ein Coding-Agent im JetBrains AI Assistant wie Junie: Er ergänzt fehlende Annotationen Modul für Modul, der checkJs-Lauf entscheidet über die Abnahme, und Beschreibungen, die nicht mehr zum Code passen, werden aufgespürt statt fortgeschrieben. Wer später doch auf .ts-Dateien umsteigen will, findet den Weg im Seminar TypeScript für Einsteiger.

In vielen Teams gilt die Gleichung „Typen gleich Build-Schritt“, und deshalb bleibt manches JavaScript-Projekt ungeprüft. Dabei steht der TypeScript-Compiler längst auch für reine JavaScript-Dateien bereit: Ein @ts-check in der ersten Zeile findet in gewachsenem Code erfahrungsgemäß sofort echte Fehler – vertauschte Parameter, vergessene null-Fälle, Tippfehler in Eigenschaftsnamen. Ein JSDoc-Kommentar, den der Compiler prüft, kann nicht veralten, und genau das unterscheidet ihn von jeder Dokumentation, die neben dem Code gepflegt wird.
Themen und Inhalte für Ihre Beratung, Coaching, Workshop, Training, Schulung und Weiterbildung:

JSDoc und TypeScript: typgeprüftes JavaScript ohne Build-Schritt

Typprüfung ohne Build-Schritt
  • Warum JSDoc-Typen: JavaScript-Projekte prüfen, ohne auf .ts-Dateien umzusteigen
  • Der TypeScript-Sprachdienst in VS Code und WebStorm wertet JSDoc auch in .js-Dateien aus
  • Einstieg pro Datei mit // @ts-check, Ausnahmen mit // @ts-nocheck
  • Projektweit mit jsconfig.json oder tsconfig.json: allowJs, checkJs, noEmit
  • Typcheck mit tsc --noEmit als npm-Skript und Schritt in der CI-Pipeline
  • Strenge Prüfung auch für JavaScript: strict und noImplicitAny in JSDoc-Projekten
  • TypeScript 7 und JavaScript-Dateien: was sich bei der JSDoc-Auswertung im nativen Compiler ändert
  • Abwägung: JSDoc, .ts mit Typ-Entfernung in Node.js oder voller Umstieg auf TypeScript
Funktionen und Klassen annotieren
  • Funktionen mit @param und @returns typisieren, optionale Parameter und Standardwerte
  • @type für Variablen und Konstanten, @satisfies zur Prüfung ohne Typverlust
  • Beschreibende Tags: @example, @deprecated, @throws und @since
  • Klassen dokumentieren: Felder im Konstruktor, @readonly, @private und #-Felder
  • Klassenhierarchien mit @extends und @implements absichern
  • Mehrere Aufrufsignaturen einer Funktion mit @overload beschreiben
Eigene und erweiterte Typen in JSDoc
  • Objekttypen mit @typedef und @property definieren und wiederverwenden
  • Funktionstypen für Callbacks und Event-Handler mit @callback
  • Generische Funktionen und Klassen mit @template, Einschränkungen per extends
  • Union- und Literal-Typen in JSDoc, Konstanten mit /** @type {const} */ festschreiben
  • Typwächter in JSDoc-Syntax: @returns {wert is Kunde} und Assertion-Funktionen
  • Utility-Typen wie Partial, Pick und ReturnType in Kommentaren nutzen
  • Typen aus anderen Dateien mit @import oder import()-Typen einbinden
  • Komplexe Typen in eine handgeschriebene .d.ts auslagern, Logik bleibt in .js
Typen für Bibliotheken ausliefern
  • .d.ts-Dateien aus JSDoc erzeugen: declaration und emitDeclarationOnly
  • package.json für Typen: types und Bedingung types im exports-Feld
  • Prüfen, ob Typen bei Nutzer:innen ankommen: Beispielprojekt und @arethetypeswrong/cli
  • Erzeugte Deklarationen als öffentliche API versionieren und Brüche erkennen
API-Dokumentation mit JSDoc erzeugen
  • Dokumentationswebsite mit dem jsdoc-Generator erzeugen, Konfigurationsdatei anlegen
  • Themes auswählen und an das eigene Erscheinungsbild anpassen
  • Markdown in Kommentaren aktivieren und Tutorials als eigene Seiten einbinden
  • Querverweise zwischen Modulen und Dateien mit {@link} und @see
  • Grenzen des klassischen Generators bei TypeScript-Syntax wie import() und Utility-Typen
TypeDoc und Markdown-Ausgabe
  • TypeDoc einrichten (derzeit mit TypeScript 6): Einstiegspunkte, typedoc.json, Ausgabe als Website
  • JavaScript-Projekte mit TypeDoc dokumentieren: über erzeugte .d.ts oder allowJs
  • Markdown-Dokumente für Wiki oder Repository mit typedoc-plugin-markdown
  • Lücken finden: TypeDoc-Warnungen für undokumentierte Exporte als Fehler behandeln
  • Dokumentation in der CI bauen und z. B. auf GitHub Pages veröffentlichen
REST-APIs und Projekteinstieg dokumentieren
  • REST-Endpunkte beschreiben: OpenAPI als Vertrag, JSDoc für Handler und Datentypen
  • POST- und PUT-Anfragen: Request-Body, Validierung und Antwortcodes dokumentieren
  • Laufzeitvalidierung und JSDoc-Typ aus einem gemeinsamen Schema ableiten, z. B. Zod
  • README als Einstieg: Installation, kurzes Beispiel, Verweis auf die API-Dokumentation
  • Kommentarqualität per Lint-Regel sichern mit eslint-plugin-jsdoc
JSDoc-Pflege mit dem JetBrains AI Assistant
  • Agent ergänzt fehlende JSDoc-Typen modulweise; ein checkJs-Lauf ohne neue Fehler ist die Abnahme
  • Kommentare gegen den Code abgleichen lassen: umbenannte @param-Namen, falsche @returns
  • @example-Blöcke vom Agenten in ausführbare Tests überführen, damit Beispiele stimmen
  • Geänderte .d.ts im Diff als Änderung der öffentlichen API lesen, bevor ein Release erscheint
  • Projektregel für den Agenten: Dateien bleiben .js, keine TypeScript-Syntax im Quellcode
Praxisprojekt: Validierungsbibliothek als typisiertes npm-Paket
  • Vorhandene JavaScript-Bibliothek für Formularvalidierung mit checkJs prüfbar machen
  • Öffentliche Funktionen mit @typedef, @template und @example beschreiben
  • .d.ts erzeugen, exports einrichten und die Typen in einem TypeScript-Beispielprojekt testen
  • API-Website mit TypeDoc und README in der CI erzeugen
Lernziele
  • Sie aktivieren die Typprüfung für JavaScript-Dateien mit checkJs und verankern sie in Editor und CI.
  • Sie annotieren Funktionen, Klassen, generische Typen, Typwächter und Utility-Typen in JSDoc-Syntax.
  • Sie liefern eine JavaScript-Bibliothek mit erzeugten .d.ts-Dateien und korrekt konfigurierter package.json aus.
  • Sie erstellen API-Dokumentationen mit JSDoc oder TypeDoc als Website oder Markdown und dokumentieren REST-Endpunkte.
  • Sie entscheiden begründet, ob ein Projekt bei JSDoc bleibt oder auf TypeScript-Dateien umsteigt.
Zielgruppe
  • Teams mit JavaScript-Codebasen, die Typprüfung ohne Build-Schritt einführen wollen
  • Bibliotheksautor:innen, die npm-Pakete mit Typen und Dokumentation veröffentlichen
  • Entwickler:innen und technische Fachkräfte, die für API-Dokumentation zuständig sind

*) Die Inhalte werden individuell abgestimmt und mit Praxisbeispielen abgerundet.

Ein Symbol für einen Kalender.

Offene Termine

Kostenlose Reservierung
Ein Symbol für Angebot erhalten.

Unser Angebot

Sind Sie auf der Suche nach einer Veranstaltung, die genau Ihrem Bedarf entspricht? Einer Veranstaltung, welche nur Inhalte vermittelt, die Sie selbst gewählt haben und speziell auf Ihr Unternehmen zugeschnitten ist? Dann sind Sie bei uns richtig!

Dauer

Ein Symbol für Dauer.
ab 1 Tag (8 UE)

Die Dauer richtet sich nach Ihren Vorstellungen und inhaltlichen Wünschen. Sie bekommen genau das, was Sie brauchen.

Preis

Ein Symbol für Preis.
ab 900 EUR (Nettopreis)
ab 1.071 EUR (Bruttopreis)

Die Preise verstehen sich bei Unternehmern gemäß § 14 BGB zzgl. MwSt. Der dargestellte Ab-Preis gilt für firmeninterne Veranstaltungen und entspricht dem niedrigsten Gesamtpreis für Veranstaltungen mit bis zu drei (3) Teilnehmenden.

Termin

Ein Symbol für einen Kalender.
Ganztägig + halbtägig
nach Vereinbarung

Ihr Wunschtermin wird bei der Planung berücksichtigt. Die Veranstaltung findet ganztägig + halbtägig zu flexiblen Zeiten statt.

Ihre Vorteile

Ein Symbol für ein Vorgespräch durchführen.
Persönliches Vorgespräch
Ein Symbol für die individuelle Vorbereitung.
Individuelle Vorbereitung
Ein Symbol für Experten aus der Praxis.
Experten aus der Praxis
Ein Symbol für ein Zertifikat.
Inklusive Zertifikat

Unsere Garantien

1. Relevanz-Garantie

Wir passen den Inhalt spezifisch an die Bedürfnisse jedes Teilnehmers an. Irrelevante Themen werden ausgespart, um den größtmöglichen Nutzen zu garantieren.

2. Qualitäts-Garantie

Durch regelmäßiges Feedback optimieren wir unsere Schulungen kontinuierlich und garantieren Ihnen ein Lernerlebnis der Extraklasse.

3. Zufriedenheits-Garantie

Unsere Zufriedenheitsgarantie spricht für sich – bei Unzufriedenheit entstehen Ihnen keine Kosten.

Wir helfen gerne weiter!

Rufen Sie uns an, schreiben eine E-Mail oder nutzen das Kontaktformular.

Jetzt anfragen
Einige Unternehmen, für die wir tätig waren

DAW SE

Kassenärztliche Vereinigung Bayerns

Staude Software GmbH

Teilnehmer

Feedback

Herr Hecker ist sehr gut auf individuelle Wünsche, Fragen und Anregungen eingegangen. Eine sehr informative, interessante und gelungene Veranstaltung.
Teilnehmer

Feedback

Herr Hecker hat das Thema sehr anschaulich dargestellt und ist auf alle Fragen eingegangen. Ich fühle mich jetzt gut vorbereitet, um durchzustarten.
Teilnehmer

Feedback

Die gelassene, professionelle Art hat mir gut gefallen. Kompetent, engagiert, professionell. Gute Beispiele, sympathisches Auftreten. Eigene Themenideen wurden aufgegriffen.
Unser Angebot für Ihre firmeninterne Beratung, Coaching, Workshop, Training und Weiterbildung

Lösungen für Ihren Bedarf an Coaching, Workshop, Training, Schulung und Weiterbildung

Profitieren Sie von unserer langjährigen Expertise in der beruflichen Weiterbildung, modernen Lernmethoden und einem Portfolio von über 600 IT-, Online- und Digital-Beratungsleistungen.
Selbstverständlich lassen sich die einzelnen Themen kombinieren. So erhalten Sie genau die Weiterbildung, die Sie wünschen und brauchen - als Coaching, Workshop, Training, Schulung und Weiterbildung!

✓
Ein Symbol für eine einzelne Person.

Für eine Person

Training & Coaching für Einzelpersonen

  • Passgenaue Inhalte auf den einzelnen Teilnehmer zugeschnitten
  • Ein sehr effektives Format, das schnell Ergebnisse bringt
  • Individuelles Training und Coaching motivieren und wirken
Jetzt anfragen
✓
Ein Symbol für eine Gruppe von Personen.

Für eine Gruppe

Training & Workshops für Teams und Abteilungen

  • Bedarfsgerechte Inhalte auf die Herausforderung der Praxis zugeschnitten
  • Konsequente Praxisorientierung, modernste Techniken und Tools
  • Neue Fähigkeiten und Kenntnisse nachhaltig in den Arbeitsalltag integrieren
Jetzt anfragen
✓
Ein Symbol für ein Unternehmen.

Für eine Firma

Training-Komplett-Lösungen für Ihr Unternehmen‍

  • Ganzheitliche Konzepte für Ihre Mitarbeiterentwicklung
  • Individueller Skill-Katalog zur Erweiterung Ihres internen Weiterbildungsangebots
  • Nachhaltige Personalentwicklung realisieren
Jetzt anfragen

Anfrage für eine unverbindliche + kostenlose Erstberatung zum Thema

JSDoc und TypeScript - Beratung, Coaching, Workshop, Training, Schulung und Weiterbildung

Wir freuen uns über Ihre Anfrage und antworten so schnell es geht!

Ich interessiere mich für den Termin:

Termin anfragen

Das Angebot von "HECKER CONSULTING" richtet sich ausschließlich an Unternehmen und Behörden (iSv § 14 BGB). Verbraucher (§ 13 BGB) sind vom Vertragsschluss ausgeschlossen. Mit Absendung der Anfrage bestätigt der Anfragende, dass er nicht als Verbraucher, sondern in gewerblicher Tätigkeit handelt. § 312i Abs. 1 S. 1 Nr. 1-3 und S. 2 BGB (Pflichten im elektronischen Geschäftsverkehr) finden keine Anwendung.

Vielen Dank, Ihre Nachricht wurde empfangen!
Beim Absenden des Formulars ist etwas schiefgelaufen.
Beratung, Coaching, Workshop, Training, Schulung

Ähnliche Leistungen, die Sie interessieren könnten.

Wir erweitern ständig unser Beratungsportfolio. Über 600 IT-, Online-, Digital-Beratungsleistungen haben wir für Sie im Programm. Selbstverständlich lassen sich die einzelnen Themen kombinieren. So erhalten Sie genau die Beratung, die Sie wünschen und brauchen - als Coaching, Workshop, Training, Schulung und Weiterbildung!

Mehr IT-, Online-, Digital-Beratungsleistungen anzeigen >>
Nach oben