changelog 📝, 5.0.0

[ci skip]
This commit is contained in:
Jannis R 2020-01-05 17:50:06 +01:00
parent e2567efcc2
commit 42b2a8a7bf
No known key found for this signature in database
GPG key ID: 0FE83946296A88A5
4 changed files with 37 additions and 4 deletions

View file

@ -1,5 +1,38 @@
# Changelog # Changelog
## `5.0.0`
Note that this version is not backwords-compatible with `4.*`. Check out [the migration guide](migrating-to-5.md).
### breaking changes 💥
- 2f8f82f require Node `>=10`
- 29a2cf3/2b9280e add `plannedArrival`/`plannedDeparture`/`plannedWhen`, `scheduled*` -> `planned*`/`prognosed*`
- 938a6f2/2d1d482 add `plannedArrivalPlatform`/`plannedDeparturePlatform`/`plannedPlatform`, `scheduled*` -> `planned*`/`prognosed*`
- 35e44d4 `parseWarning()`/`parseHint()`: change signature to `(profile, raw, data) => …`
- 4162328 `createClient()`: change signature to `(profile, userAgent, opt = {}) => …`
- fb7a565/252ce5b/9fc6664/2cfee22/e2567ef change parse fns signature to `({profile, opt, res, common}) => (rawData) => …`
- baff692 `journeys()`: don't request nr of results by default
- b8496be DB `journeys()`: let `journey.price` default to `null`
- 6d5c608 call `request()` via `profile`
### features
- f8210c5/9c47a39/0c145d3/9a89cd0 `journeys()`: add `walkingSpeed` option
- a40006f/1afe4ca BVG: support *BerlKönig*, add E2E test
- 352fa2e parse more warning fields
- 8b2a5a8 `parseIcon()`: use `.txt` & `.txtS` as text fallback
- 39a6267 request formatters (e.g. `formatTripReq()`) via `profile`
### bugfixes 🐛
- 5ea22f7 `parseHint()`: parse `.code` & `.text` properly
- 29d7bd4 `parseJourney()`: fix `journey.scheduledDays` year
- 9a6bc2d `parseWarning()`: call `parseDateTime()` via `profile`
- 7b7293e `request()`: use *transformed* `req`
[🏷 `5.0.0`](https://github.com/public-transport/hafas-client/releases/tag/5.0.0), 2020-01-05
## `4.8.0` ## `4.8.0`
- 56dee66/46eadcf/1611635 add [*DB Busradar NRW* profile](../p/db-busradar-nrw) - 56dee66/46eadcf/1611635 add [*DB Busradar NRW* profile](../p/db-busradar-nrw)

View file

@ -2,7 +2,7 @@
## If you use Node `8` ("Carbon")… ## If you use Node `8` ("Carbon")…
…migrate to Node `10` ("Dubnium"), sorry. [Node `8` is out of maintenance now](https://nodejs.org/en/about/releases/). …migrate to Node `10` ("Dubnium"), sorry. [Node `8` is out of maintenance now](https://nodejs.org/en/about/releases/). 83f43c6
## new fields for departure/arrival time & delays ## new fields for departure/arrival time & delays

View file

@ -1,4 +1,4 @@
Copyright (c) 2017, Jannis R Copyright (c) 2020, Jannis R
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

View file

@ -1,7 +1,7 @@
{ {
"name": "hafas-client", "name": "hafas-client",
"description": "Client for HAFAS public transport APIs.", "description": "Client for HAFAS public transport APIs.",
"version": "4.8.0", "version": "5.0.0",
"main": "index.js", "main": "index.js",
"files": [ "files": [
"index.js", "index.js",
@ -17,7 +17,7 @@
"contributors": [ "contributors": [
"Julius Tens <mail@juliustens.eu>" "Julius Tens <mail@juliustens.eu>"
], ],
"homepage": "https://github.com/public-transport/hafas-client/tree/4.8.0", "homepage": "https://github.com/public-transport/hafas-client/tree/5.0.0",
"repository": "public-transport/hafas-client", "repository": "public-transport/hafas-client",
"bugs": "https://github.com/public-transport/hafas-client/issues", "bugs": "https://github.com/public-transport/hafas-client/issues",
"license": "ISC", "license": "ISC",