kbruen/db-vendo-client
1
0
Fork 0
mirror of https://github.com/public-transport/db-vendo-client.git synced 2025-11-03 17:46:32 +02:00
Code Issues Projects Releases Packages 1 Wiki Activity Actions
db-vendo-client/p/db
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 location method: docs 📝 2018-01-26 17:24:02 +01:00
index.js rename d.remarks -> d.hints, parseRemark -> parseHint 2018-06-07 16:34:50 +02:00
loyalty-cards.js DB profile 2017-11-12 23:51:41 +01:00
products.js DB: tram mode should be train 🐛 2018-04-24 16:59:35 +02:00
readme.md docs: methods, usage examples, more related projects 2017-12-17 20:04:17 +01:00

readme.md

DB profile for hafas-client

Deutsche Bahn (DB) is the largest German long-distance public transport company. This profile adds DB-specific customizations to hafas-client. Consider using db-hafas, to always get the customized client right away.

Usage

const createClient = require('hafas-client')
const dbProfile = require('hafas-client/p/db')

// create a client with DB profile
const client = createClient(dbProfile)

Customisations

  • supports 1st and 2nd class with journey()
  • supports their loyalty cards with journey()
  • parses DB-specific products (such as InterCity-Express)
  • exposes the cheapest ticket price for a journey