# wili

[![License](https://img.shields.io/github/license/idleberg/node-wili?color=blue&style=for-the-badge)](https://github.com/idleberg/node-wili/blob/main/LICENSE)
[![Version](https://img.shields.io/npm/v/wili?style=for-the-badge)](https://www.npmjs.org/package/wili)
![GitHub branch check runs](https://img.shields.io/github/check-runs/idleberg/node-wili/main?style=for-the-badge)

[English](README.md) | **Deutsch**

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

## Installation

`npm install wili`

## Anwendung

Beispielanwendung:

```js
import { createWienerLinien } from 'wili';

const wili = createWienerLinien();

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

const { trafficInfos } = await wili.trafficInfoList(options);
```

## 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](https://till.mabe.at/rbl/?line=214433687&station=231116899) 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](https://opensource.org/licenses/MIT).