kbruen/db-vendo-client
1
0
Fork 0
mirror of https://github.com/public-transport/db-vendo-client.git synced 2025-02-23 23:29:35 +02:00
Code Issues Projects Releases Packages 1 Wiki Activity Actions
db-vendo-client/p/oebb
History
Jannis R d2257c26ff
rename d.remarks -> d.hints, parseRemark -> parseHint 
HAFAS returns notes for journey legs, stopovers and departures.

There are two kinds of notes: "remarks" (in `remL`) and HAFAS
Information Manager (HIM) notes (in `himL`). The former describe
the regular operating situation, e.g. "bicycles allows", whereas
the latter describe cancellations, construction work, etc.

The planned naming scheme for hafas-client:
- hints: notes from `remL` for regular operation
- warnings: notes from `himL` for cancellations, construction, etc
- remarks: both "notes" and "warnings"

This commit prepares the new naming scheme by renaming the
existing parsing logic of `remL` to "hints". Follow-up commits
will add `parseWarning`.
2018-06-07 16:34:50 +02:00
..
example.js adapt docs and examples to 40b559f 📝 2018-03-16 17:28:52 +01:00
index.js rename d.remarks -> d.hints, parseRemark -> parseHint 2018-06-07 16:34:50 +02:00
products.js products[].product -> products[].id 2018-03-16 17:15:09 +01:00
readme.md ÖBB: code style 👕, add TODOs, improve docs 📝 2017-12-29 23:46:07 +01:00

readme.md

ÖBB profile for hafas-client

Österreichische Bundesbahnen (ÖBB) is the largest Austrian long-distance public transport company. This profile adds ÖBB-specific customizations to hafas-client. Consider using oebb-hafas, to always get the customized client right away.

Usage

const createClient = require('hafas-client')
const oebbProfile = require('hafas-client/p/oebb')

// create a client with ÖBB profile
const client = createClient(oebbProfile)

Customisations

  • parses ÖBB-specific products (such as RailJet)
  • parses invalid empty stations from the API as locations