TypeScript

Aus CodicaTipps
Zur Navigation springen Zur Suche springen

TypeScript ist eine JavaScript-Weiterentwicklung, die Typsicherheit bietet. TypeScript wird in JavaScript übersetzt.

TypeScript und Node.js

Allgemein

Siehe

Bauen eines npm-Moduls mit TypeScript

Siehe

TypeScript und Jest

 npm install --save-dev jest ts-jest @types/jest
 npx ts-jest config:init

Außerdem muss man in der tsconfig.json in compilerOptions => types noch "jest" aufnehmen. Das kann dann so aussehen:

 "types": ["node","jest"],

Siehe

TypeScript und einzelne Anwendungsfelder

TypeScript und Node.js

Das Aufsetzen eines Nodejs-Projekts mit TypeScript wird bei Khalil Stemmer geschildert.

Wie man eine Library mit TypeScript baut wird von Mean geschildert.

Ein Kommandozeilen-Script in TypeScript auf Basis von Node.js zeigt


Beispiel für Library in Typescript

Siehe

Im Terminal:

 mkdir $PROJEKT_VERZEICHNIS
 cd $PROJEKT_VERZEICHNIS
 npm init
 npm install --save-dev ts-jest typescript jest @types/jest ts-node
 npx tsc --init

Anpassen von package.json

 "main":"./dist/index.js",
 "scripts": {
   "test": "jest",
   "test:watch": "jest --watch",
   "build": "tsc"
 },
  

Anpassen von tsconfig.json

 "rootDir": "./src",                                 
 "types": ["jest"],
 "declaration": true,
 "declarationMap": true,
 "outDir": "./dist",
   

Im Terminal

 npx ts-jest config:init

In jest.config.js folgende Zeile in module.exports={ einfügen:

 testPathIgnorePatterns:["/node_modules/","/dist/"],

Einrichten von git. Erzeugen der Datei .gitignore im Projektverzeichnis:

 node_modules/
 dist/

Initialisierung und erster Commit:

 git init
 git status
 git add .
 git commit

Beispiel für Kommandozeilen-Programm in Typescript

Zuerst Schritte ausführen wie in TypeScript#Beispiel_f.C3.BCr_Library_in_Typescript.

Dann commander installieren

 npm install --save commander @commander-js/extra-typings

nodemon installieren:

 npm install --save-dev nodemon @types/node

In package.json

 "bin": {
   "APPNAME":"./dist/index.js"
 },
 "scripts": {
   "test": "jest",
   "test:watch": "jest --watch",
   "build": "tsc",
   "dev:version": "nodemon --watch 'src/**/*.ts' --exec 'ts-node' 'src/index.ts' -- '--version'"
  },

APPNAME muss dabei durch den Namen des Kommandozeilenprogramms ersetzt werden.

In src/index.ts

 #!/usr/bin/env node
 import { program } from "commander";
 const pkg = require("../package.json");
 program
   .name(pkg.name)
   .version(pkg.version)
   .description(pkg.description)
   .action(()=>{
     console.log("hi")
   })
   .parse();

In tsconfig.json:

   "types": ["jest","node"],


Statt commander kann man z.B. auch

nutzen

TypeScript literals ohne einen bestimmten String

Siehe

typensicherer Event-Handling

Siehe

TypeScript und PostgreSQL

TypeScript kann jedes JavaScript/Node.js-Framework für den Zugriff auf PostgreSQL nutzen. Darüber hinaus gibt es weitere Bibliotheken:

TypeScript - Laufzeit-Typ-Überprüfung

Type Script kann zur Kompilierzeit Typensicherheit sicherstellen. Verschiedene Tools können auf Basis von TypeScript-Typen Prüfmethoden erstellen, um zur Laufzeit z.B. ein in JSON eingelesenen Typ auf Übereinstimmung mit dem TypeScript-Typ abzugleichen:

Eine Möglichkeit ist typescript-json-validator:

 npm install --save-dev typescript-json-validator


In src/types/types.ts werden die zu validierenden Typen exportiert.

In der package.json wird unter "scripts" folgender Eintrag hinzugefügt:

     "build:validators": "typescript-json-validator --defaultProps=false --useNamedExport --collection src/types/types.ts && sed -i  -e \"s/export {/export type {/\" -e s/\\\"format\\\":\\\"fast\\\",// -e s/\\\"nullable\\\":true,// -e s/\\\"uniqueItems\\\":true,// -e s/\\\"unicode\\\":true,// src/types/types.validator.ts",

Der sed-Befehl sollte folgende Fehler vermeiden:

  • "Das Argument vom Typ \"{ allErrors: true; coerceTypes: false; format: string; nullable: boolean; unicode: true; uniqueItems: boolean; useDefaults: false; }\" kann dem Parameter vom Typ \"Options\" nicht zugewiesen werden.\n Das Objektliteral kann nur bekannte Eigenschaften angeben, und \"\"format\"\" ist im Typ \"Options\" nicht vorhanden.",
  • Das erneute Exportieren eines Typs erfordert bei Festlegung des Flags \"--isolatedModules\" die Verwendung von \"export type\".",


Siehe auch

Siehe auch

TypeScript REST-API

TypeScript REST-API-Server auf Basis von HAPI

Siehe

mit Authentifizierung

Siehe

TypeScript API from PostgresDB

Siehe

TypeScript API erstellen

Siehe

Weiterführendes

Siehe auch