db-vendo-client/docs/station.md

97 lines
1.5 KiB
Markdown
Raw Normal View History

# `station(id, [opt])`
2018-01-26 17:23:45 +01:00
2018-06-04 19:01:09 +02:00
`id` must be in one of these formats:
2018-01-26 17:23:45 +01:00
```js
2018-06-04 19:01:09 +02:00
// a station ID, in a format compatible with the profile you use
2018-01-26 17:23:45 +01:00
'900000123456'
// an FPTF `station` object
{
type: 'station',
id: '900000123456',
name: 'foo station',
location: {
type: 'location',
latitude: 1.23,
longitude: 3.21
}
}
```
With `opt`, you can override the default options, which look like this:
```js
{
2018-07-09 12:40:38 +02:00
stationLines: false, // parse & expose lines of the station?
language: 'en' // language to get results in
}
2018-01-26 17:23:45 +01:00
## Response
As an example, we're going to use the [VBB profile](../p/vbb):
```js
const createClient = require('hafas-client')
const vbbProfile = require('hafas-client/p/vbb')
const client = createClient(vbbProfile, 'my-awesome-program')
2018-01-26 17:23:45 +01:00
2018-06-04 19:01:09 +02:00
client.station('900000042101') // U Spichernstr.
2018-01-26 17:23:45 +01:00
.then(console.log)
.catch(console.error)
```
The response may look like this:
```js
{
2018-07-11 00:32:57 +02:00
type: 'stop',
2018-01-26 17:23:45 +01:00
id: '900000042101',
name: 'U Spichernstr.',
location: {
type: 'location',
latitude: 52.496581,
longitude: 13.330616
},
products: {
suburban: false,
subway: true,
tram: false,
bus: true,
ferry: false,
express: false,
regional: false
},
lines: [ {
type: 'line',
id: 'u1',
mode: 'train',
product: 'subway',
2018-01-26 17:23:45 +01:00
public: true,
name: 'U1',
2018-01-26 17:23:45 +01:00
class: 2,
symbol: 'U',
nr: 1,
metro: false,
express: false,
night: false
},
// …
{
type: 'line',
2018-01-26 17:23:45 +01:00
id: 'n9',
mode: 'bus',
product: 'bus',
2018-01-26 17:23:45 +01:00
public: true,
name: 'N9',
2018-01-26 17:23:45 +01:00
class: 8,
symbol: 'N',
nr: 9,
metro: false,
express: false,
night: true
} ]
}
```