kbruen/db-vendo-client
1
0
Fork 0
mirror of https://github.com/public-transport/db-vendo-client.git synced 2025-02-23 15:19:35 +02:00
Code Issues Projects Releases Packages 1 Wiki Activity Actions

adapt docs to 3c9c5cb 📝

Browse source
This commit is contained in:
Jannis R 2018-06-04 19:01:09 +02:00 • committed by Jannis Redmann
parent 665bed9f79
commit 2d11cfae1e
2 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/readme.md
View file

@ -4,7 +4,7 @@
- [`journeyLeg(ref, lineName, [opt])`](journey-leg.md) – get details for a leg of a journey
- [`departures(station, [opt])`](departures.md) – query the next departures at a station
- [`locations(query, [opt])`](locations.md) – find stations, POIs and addresses
- [`location(id)`](location.md) – get details about a location
- [`station(id)`](station.md) – get details about a station
- [`nearby(location, [opt])`](nearby.md) – show stations & POIs around
- [`radar(north, west, south, east, [opt])`](radar.md) – find all vehicles currently in a certain area

8
docs/location.md → docs/station.md
View file

@ -1,9 +1,9 @@
# `location(station)`
# `station(id)`
`station` must be in one of these formats:
`id` must be in one of these formats:
```js
// a station ID, in a format compatible to the profile you use
// a station ID, in a format compatible with the profile you use
'900000123456'
// an FPTF `station` object
@ -29,7 +29,7 @@ const vbbProfile = require('hafas-client/p/vbb')
const client = createClient(vbbProfile)
client.location('900000042101') // U Spichernstr.
client.station('900000042101') // U Spichernstr.
.then(console.log)
.catch(console.error)
```