wili

A Node client for the Wiener Linien public transport API

Usage no npm install needed!

<script type="module">
  import wili from 'https://cdn.skypack.dev/wili';
</script>

README

wili

npm npm CI David

English | Deutsch

Node Wrapper für das Echtzeitdaten API der Wiener Linien

Installation

yarn add wili || npm install wili

Voraussetzungen

Hinweis: Seit November 2019 wird kein gültiger API Key mehr für die Verwendung benötigt. Zuvor erworbene Keys können weiterhin verwendet werden.

Anwendung

Beispielanwendung:

import { WienerLinien } from 'wili';

// Der API-Key kann weggelassen werden, wenn
// process.env.WIENER_LINIEN_API_KEY gesetzt ist
const wl = new WienerLinien(API_KEY);

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

// Promise API
wl.trafficInfoList(options)
.then( data => {
  console.log(data.trafficInfos);
})
.catch( error => {
  console.error(error);
});

// async/await
(async () => {
  try {
    let data = await wl.trafficInfoList(options);
    console.log(data.trafficInfos);
  } catch (output) {
    console.error(error);
  }
})();

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