Arbeiten mit Typings in VS Code (DOCUMENTS)
Worum geht es?
Typings sind Typbeschreibungen (.d.ts-Dateien und JSDoc-Kommentare), mit denen VS Code unsere DOCUMENTS-Skripte versteht, obwohl sie in reinem JavaScript geschrieben sind. VS Code nutzt dafür im Hintergrund den TypeScript-Sprachdienst. Das Ergebnis:
- IntelliSense: Autovervollständigung für context, util, DocFile, FileResultset & Co. inklusive Parameterhilfe.
- Doku direkt im Editor: Beim Hovern über eine Funktion erscheint ihre Beschreibung. Das spart den Blick in die Portalscripting-API-Doku.
- Fehler vor dem Upload finden: Tippfehler in Methodennamen, falsche Parametertypen oder vergessene null-Prüfungen werden markiert, bevor das Skript auf dem Server landet.
- Sichere Refactorings: "Umbenennen" (F2) und "Alle Verweise suchen" (Shift+F12) funktionieren projektweit.
Diese Seite zeigt, wie Typings in unserem Workspace eingerichtet sind und wie ihr sie in eigenen Skripten nutzt. Alle Beispiele stammen aus unserer Codebasis.
Projekt-Setup
Damit VS Code die Typings findet, braucht unser Workspace drei Dinge: eine jsconfig.json im Root,...
Grundlagen: Typen mit JSDoc
In JavaScript schreiben wir Typen nicht in den Code, sondern in JSDoc-Kommentare (/** ... */). VS...
Eigene Typen definieren
Sobald ein Objekt an mehreren Stellen vorkommt (Konfigurationen, Rückgabewerte, JSON von externen...
DOCUMENTS-API-Typen nutzen
Die wichtigsten Objekte sind ohne eigenes Zutun typisiert: context, util und alle API-Klassen wie...
Bibliotheken und eigene .d.ts-Dateien
Die otris-Bibliotheken otrUpgrade, otrAssert und util.otrLogger bringen eigene Typings mit, größt...
Stolperfallen
Die meisten Probleme haben eine Ursache: Ein Typ, den VS Code nicht kennt, wird ohne Typprüfung s...
Checkliste für neue Skripte
Kein // @ts-nocheck: checkJs prüft jedes neue Skript automatisch. Jede Funktion hat @param und ...
Empfohlene jsconfig.json
Diese Vorlage passt für jeden DOCUMENTS-Workspace: checkJs und alwaysStrict stehen auf true. Proj...