simono41/db-rest
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

/journeys docs: update parameters list 📝

Browse source
This commit is contained in:
Jannis R 2019-01-21 22:32:45 +08:00
parent a4e46ff055
commit ef058bdeba
No known key found for this signature in database
GPG key ID: 0FE83946296A88A5
1 changed files with 10 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
docs/index.md
View file

@ -109,7 +109,9 @@ Output from [`require('db-hafas').journeys(…)`](https://github.com/derhuerst/d
## other parameters ## other parameters
- `when`: A [UNIX timestamp](https://en.wikipedia.org/wiki/Unix_time) or anything parsable by [`parse-messy-time`](https://github.com/substack/parse-messy-time#example). Default: now. - `departure`/`arrival`: A [UNIX timestamp](https://en.wikipedia.org/wiki/Unix_time) or anything parsable by [`parse-messy-time`](https://github.com/substack/parse-messy-time#example). Default: now. Use either `departure` or `arrival`.
- `earlierThan`: By passing an identifier from another query, get earlier journeys than before. Mutually exlusive with `laterThan`, `departure` & `arrival`.
- `laterThan`: By passing an identifier from another query, get later journeys than before. Mutually exclusive with `earlierThan`, `departure` & `arrival`.
- `results`: Maximum number of results. Default: `5`. - `results`: Maximum number of results. Default: `5`.
- `via`: Station ID. Default: `null`. - `via`: Station ID. Default: `null`.
- `stopovers`: Return stations on the way? Default: `false`. - `stopovers`: Return stations on the way? Default: `false`.
@ -118,17 +120,14 @@ Output from [`require('db-hafas').journeys(…)`](https://github.com/derhuerst/d
- `accessibility`: Possible values: `partial`, `complete`. Default: `none`. - `accessibility`: Possible values: `partial`, `complete`. Default: `none`.
- `bike`: Return only bike-friendly journeys. Default: `false`. - `bike`: Return only bike-friendly journeys. Default: `false`.
- `tickets`: Return information about available tickets. Default: `false`. - `tickets`: Return information about available tickets. Default: `false`.
- `language`: Language to get results in. Default: `en`.
- `polylines`: Return a shape for each leg? Default: `false`.
- `remarks`: Parse & expose hints & warnings? Default: `true`.
- `startWithWalking`: Consider walking to nearby stations at the beginning of a journey? Default: `true`.
- `scheduledDays`: Parse which days each journey is valid on? Default: `false`.
You can filter by means of transportation using these parameters:
taxi
tram
bus
ferry
subway
suburban
regional
regionalExp
national
nationalExp
- `taxi`: Include taxis? Default: `false`. - `taxi`: Include taxis? Default: `false`.
- `tram`: Include [trams](https://en.wikipedia.org/wiki/Tram)? Default: `true`. - `tram`: Include [trams](https://en.wikipedia.org/wiki/Tram)? Default: `true`.
- `ferry`: Include [ferries](https://en.wikipedia.org/wiki/Ferry)? Default: `true`. - `ferry`: Include [ferries](https://en.wikipedia.org/wiki/Ferry)? Default: `true`.