awtln-ws1819 v1.2.0

Projekt des Moduls "Aktuelle Webtechnologien und Frameworks" im Wintersemester 18/19

von Lena Nörenberg, Can Heilgermann, Ray Köller

Seiteninhalt:

1. Unser eigenes Modul

   1. Installation
   2. Test
   3. Aufbau
   4. Import
   5. Verwendung

Unser eigenes Modul (awtln-ws1819)

Installation

Unser Modul kann mit dem Node Package Manager installiert werden:

npm install awtln-ws1819

Liegt unser Modul bereits lokal vor, so müssen vor der Verwendung erst alle notwendigen Dependencies mittels

npm install

installiert werden.

Test

Unser Modul wird mit mocha und der Assertion-Library chai getestet. Zum anzeigen der Code-Coverage wird Istanbul verwendet.
Der Test kann wie folgt gestartet werden:

npm test

Aufbau

Das Modul awtln-ws1819 besteht aus einer Funktion mit dem Namen parse(), die aus einem übergebenen String im JSON Format ein für unsere Zwecke angepasstes Javscript Objekt erzeugt.
Diese Funktion parse() wird mittels

module.exports = parse;

exportiert und steht nun nach einem Import auch in anderen Dateien zur Verfügung.

Import

Um unser Modul in anderen Dateien nutzen zu können, muss dieses importiert werden.

import parse from 'awtln-ws1819';

Verwendung

Nachdem unser Modul wie oben beschrieben importiert wurde, kann die Funktion des Moduls wie folgt verwendet werden:

const parsedObject = parse(JSON_STRING);