db-vendo-client/p
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
..
db rename d.remarks -> d.hints, parseRemark -> parseHint 2018-06-07 16:34:50 +02:00
insa merge pull request #32 from refactor-products 2018-03-18 13:22:24 +01:00
nahsh rename d.remarks -> d.hints, parseRemark -> parseHint 2018-06-07 16:34:50 +02:00
oebb rename d.remarks -> d.hints, parseRemark -> parseHint 2018-06-07 16:34:50 +02:00
vbb rename d.remarks -> d.hints, parseRemark -> parseHint 2018-06-07 16:34:50 +02:00
readme.md minimal profiles docs 📝 2018-01-04 22:37:47 +01:00

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…