docs & changelog for includeRelatedStations option 📝

see 1551943
This commit is contained in:
Jannis R 2018-07-10 19:01:40 +02:00
parent 1551943fdb
commit a2cd5ba187
No known key found for this signature in database
GPG key ID: 0FE83946296A88A5
2 changed files with 4 additions and 0 deletions

View file

@ -13,6 +13,7 @@ This version is not fully backwords-compatible. Check out [the migration guide](
- 84bce0c `arrivals()`/`departures()`: parse & expose platforms
- 85e0bdf `journeys()`: `startWithWalking` option with default `true`
- f6ae29c journey legs with `type: 'walking'` now have a `distance` in meters
- 1551943 `arrivals()`/`departures()`: `includeRelatedStations` option with default `true`
### breaking changes 💥

View file

@ -29,6 +29,9 @@ With `opt`, you can override the default options, which look like this:
duration: 10, // show departures for the next n minutes
stationLines: false, // parse & expose lines of the station?
remarks: true, // parse & expose hints & warnings?
// departures at related stations
// e.g. those that belong together on the metro map.
includeRelatedStations: true,
language: 'en' // language to get results in
}
```