Skip to content

Latest commit

 

History

History
127 lines (71 loc) · 2.89 KB

README.de.md

File metadata and controls

127 lines (71 loc) · 2.89 KB

wili

License Version Build

English | Deutsch

Node Wrapper für die Echtzeitdaten-API der Wiener Linien

Installation

npm install wili

Anwendung

Beispielanwendung:

import { createWienerLinien } from 'wili';

const wili = createWienerLinien();

const options = {
  relatedLine: ['U2', 'U4', 'U6']
};

try {
  const data = await wili.trafficInfoList(options);
  console.log(data.trafficInfos);
} catch (output) {
  console.error(error);
}

⚠️ Für NodeJS-Versionen unterhalb v18, muss die Klasse mit einer fetch-Implementierung instanziert werden.

Beispiel

import { createWienerLinien } from 'wili';
import fetch from 'isomorphic-fetch';

const wili = createWienerLinien(fetch);

API

monitor

Verwendung: monitor(rbl, [options])

Die Monitor Schnittstelle liefert Echtzeiten oder Planzeiten der nächsten 70 Minuten für einen Haltepunkt

Parameter:

rbl

Typen: String, Integer, Array

RBL Nummer (Rechnergestütztes Betriebsleitsystem), lässt sich hier abfragen

options.activeTrafficInfo

Typen: String, Array

Störungstypen: stoerungkurz, stoerunglang oder aufzugsinfo

newsList

Verwendung: newsList(options)

Die Schnittstelle liefert Neuigkeiten wie „Aktuelles“ oder „Aufzugswartungen”

Optionen

options.relatedLine

Typen: String, Integer, Array

Name der Linie, z.B. U1, S7, 59A (schreibungsunabhängig)

options.relatedStop

Typen: String, Integer, Array

Haltepunkt ID der Haltestelle

options.name

Typen: String, Array

Name der Nachrichtenkategorie, z.B news oder aufzugsservice

trafficInfoList

Verwendung: trafficInfoList([options])

Die Schnittstelle liefert Störungen

Optionen

options.relatedLine

Typen: String, Integer, Array

Name der Linie, z.B. U1, S7, 59A (schreibungsunabhängig)

options.relatedStop

Typen: String, Integer, Array

Haltepunkt ID der Haltestelle

options.name

Typen: String, Array

Störungstypen: stoerungkurz, stoerunglang oder aufzugsinfo

Lizenz

Diese Software unterliegt den Bestimmungen der MIT Lizenz

Spenden

Wenn Du mir einen Kaffee oder ein Bier ausgeben möchtest, freue mich über Spenden via Flattr oder Bitcoin 17CXJuPsmhuTzFV2k4RKYwpEHVjskJktRd