db-vendo-client/p/oebb/readme.md

20 lines
841 B
Markdown
Raw Normal View History

2017-12-29 10:15:32 +01:00
# ÖBB profile for `hafas-client`
[*Österreichische Bundesbahnen (ÖBB)*](https://en.wikipedia.org/wiki/Austrian_Federal_Railways) is the largest Austrian long-distance public transport company. This profile adds *ÖBB*-specific customizations to `hafas-client`. Consider using [`oebb-hafas`](https://github.com/juliuste/oebb-hafas#oebb-hafas), to always get the customized client right away.
## Usage
```js
const createClient = require('hafas-client')
const oebbProfile = require('hafas-client/p/oebb')
2017-12-29 10:16:41 +01:00
// create a client with ÖBB profile
2017-12-29 10:15:32 +01:00
const client = createClient(oebbProfile)
```
## Customisations
- parses *ÖBB*-specific products (such as *RailJet*)
- parses invalid empty stations from the API as [`location`](https://github.com/public-transport/friendly-public-transport-format/blob/1.0.1/spec/readme.md#location-objects)s