@niko-npm/wili
v0.7.1
Published
Fork of wili, a Node client for the Wiener Linien public transport API, common JS version
Downloads
27
Maintainers
Readme
wili
English | Deutsch
A Node wrapper for the Wiener Linien public transport API
Installation
npm install wili
Usage
Example usage in script:
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);
}
:warning: For NodeJS versions lower than v18, the class needs to be instantiated with a fetch
-implementation
Example
import { createWienerLinien } from 'wili';
import fetch from 'isomorphic-fetch';
const wili = createWienerLinien(fetch);
API
monitor
Usage: monitor(rbl, [options])
Returns real-time data for a station, including train information such as identifier or accessibility features.
Parameters:
rbl
Type: String
, Integer
, Array
RBL number (Rechnergestütztes Betriebsleitsystem - computer-aided operations control system), can be found this website
options.activeTrafficInfo
Type: String
, Array
Disruption type (stoerungkurz
, stoerunglang
, or aufzugsinfo
)
newsList
Usage: newsList(options)
Returns news, elevator maintenance and other information
Options
options.relatedLine
Type: String
, Integer
, Array
Train or bus number, e.g. U1, S7, 59A (case-insensitive)
options.relatedStop
Type: String
, Integer
, Array
Station ID
options.name
Type: String
, Array
Information category, e.g news
or aufzugsservice
trafficInfoList
Usage: trafficInfoList([options])
Returns interruption of operations and elevator outage
Options
options.relatedLine
Type: String
, Integer
, Array
Train or bus number, e.g. U1, S7, 59A (case-insensitive)
options.relatedStop
Type: String
, Integer
, Array
Station ID
options.name
Type: String
, Array
Disruption type (stoerungkurz
, stoerunglang
, or aufzugsinfo
)
License
This work is licensed under The MIT License