mirror of
https://github.com/public-transport/db-vendo-client.git
synced 2025-02-23 15:19:35 +02:00
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`. |
||
---|---|---|
.. | ||
db | ||
insa | ||
nahsh | ||
oebb | ||
vbb | ||
readme.md |
Profiles
This directory contains specific customisations for each endpoint, called profiles. They parse data from the API differently, add additional information, or enable non-default methods (such as journeyLeg
) if they are supported.
Each profile has it's own directory. It will be passed into hafas-client
and is expected to be in a certain structure:
const createClient = require('hafas-client')
const someProfile = require('hafas-client/p/some-profile')
// create a client with the profile
const client = createClient(dbProfile)
// use it to query data…