1.0.0 • Published 2 years ago

eck-teams-plugin-template-data-model v1.0.0

Weekly downloads
-
License
-
Repository
-
Last release
2 years ago

######################################

Teams-Template-Plugin-Data-Model

###################################### Bei Teams-Template-Plugin-Data-Model handelt es sich um eine Bibliothek, welche Definitionen zum Datenaustausch zwischen Frontend und Backend enthält.

Erstellung

Die Erstellung des Artefacts erfolgt durch Eingabe von "npx tsc" auf der Konsole im root-Verzeichnis des Artefakts. Hierdurch werden die unter dem Pfad "src" abgelegten Modellklassen zusammen mit der Index-Definitionsdatei "index.ts" zu einem Artefakt gebündelt.

War die Kompilation des Artefaktes erfolgreich, so kann dieses mittels "npm publish" veröffentlicht werden. Hierzu benötigt man jedoch einen npm-Account. Mittels "npm whoami" kann ermittelt werden, mit welchem Benutzer man bei npm angemeldet ist und unter wessen Namen somit die Veröffentlichung stattfindet. Da es nicht gestattet ist eine bereits veröffentlichte Version erneut zu veröffentlichen, sollte man vor Ausführung des "npm publish"-Befehls in der "package.json"-Datei die Version erhöhen.

Nutzung

Nachdem die Veröffentlichung des Artefakts erfolgt ist, kann dieses nun mittels "eck-teams-plugin-template-data-model" im Backend- und Frontend-Projekt eingebunden werden. Ist die Installation erfolgt, so setzt man die Version der Dependency "eck-teams-plugin-template-data-model" am besten auf einen festen Wert. Die Modelklassen des Datenmodell-Artefakts lassen sich dann einfach über das import-Komando in den Projekten nutzen. z.B.: import { LogLevel, UserState, User } from "eck-teams-plugin-template-data-model";