mirror of
https://github.com/public-transport/db-vendo-client.git
synced 2025-02-22 22:59:35 +02:00
readme, example 📝
This commit is contained in:
Jannis R
parent
6b1f22cc65
commit
2e66e647c9
2 changed files with 148 additions and 2 deletions
16
example.js
Normal file
16
example.js
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
'use strict'
|
||||
|
||||
const createClient = require('.')
|
||||
const dbProfile = require('./p/db')
|
||||
|
||||
const client = createClient(dbProfile)
|
||||
|
||||
// Berlin Jungfernheide to München Hbf
|
||||
client.journeys('8011167', '8000261', {results: 1})
|
||||
// client.departures('8011167', {duration: 1})
|
||||
// client.locations('Berlin Jungfernheide')
|
||||
// client.locations('ATZE Musiktheater', {poi: true, addressses: false, fuzzy: false})
|
||||
// client.nearby(52.4751309, 13.3656537, {results: 1})
|
||||
.then((data) => {
|
||||
console.log(require('util').inspect(data, {depth: null}))
|
||||
}, console.error)
|
||||
134
readme.md
134
readme.md
|
|
@ -1,6 +1,8 @@
|
|||
# hafas-client
|
||||
|
||||
**A client for HAFAS public transport APIs**, providing the base for [vbb-hafas](https://github.com/derhuerst/vbb-hafas) and [db-hafas](https://github.com/derhuerst/db-hafas).
|
||||
**A client for HAFAS public transport APIs**. Sort of like [public-transport-enable](https://github.com/schildbach/public-transport-enabler), but with a smaller scope. It also has customisations for the following transport networks:
|
||||
|
||||
- [Deutsche Bahn](https://en.wikipedia.org/wiki/Deutsche_Bahn) – [src](p/db/index.js)
|
||||
|
||||
[](https://www.npmjs.com/package/hafas-client)
|
||||
[](https://travis-ci.org/derhuerst/hafas-client)
|
||||
|
|
@ -8,6 +10,13 @@
|
|||
[](https://gitter.im/derhuerst)
|
||||
|
||||
|
||||
## Background
|
||||
|
||||
There's [a company called HaCon](http://hacon.de) that sells [a public transport management system called HAFAS](https://de.wikipedia.org/wiki/HAFAS). It is [used by companies all over Europe](https://gist.github.com/derhuerst/2b7ed83bfa5f115125a5) to server routing and departure information for apps. All those endpoints are similar, with the same terms and API routes, but have slightly different options, filters and enable features.
|
||||
|
||||
`hafas-client` contains all logic for communicating with these, as well as serialising from and parsing to [FPTF](https://github.com/public-transport/friendly-public-transport-format). Endpoint-specific customisations increase the quality of the returned data.
|
||||
|
||||
|
||||
## Installing
|
||||
|
||||
```shell
|
||||
|
|
@ -18,7 +27,128 @@ npm install hafas-client
|
|||
## Usage
|
||||
|
||||
```
|
||||
todo
|
||||
const createClient = require('hafas-client')
|
||||
const dbProfile = require('hafas-client/p/db')
|
||||
|
||||
const client = createClient(dbProfile)
|
||||
|
||||
// Berlin Jungfernheide to München Hbf
|
||||
client.journeys('8011167', '8000261', {results: 1})
|
||||
.then(console.log)
|
||||
.catch(console.error)
|
||||
```
|
||||
|
||||
```js
|
||||
[ {
|
||||
origin: {
|
||||
type: 'station',
|
||||
id: '8089100',
|
||||
name: 'Berlin Jungfernheide (S)',
|
||||
coordinates: {
|
||||
latitude: 52.530291,
|
||||
longitude: 13.299451
|
||||
},
|
||||
products: { /* … */ }
|
||||
},
|
||||
departure: '2017-11-13T01:00:00Z',
|
||||
|
||||
destination: {
|
||||
type: 'station',
|
||||
id: '8000261',
|
||||
name: 'München Hbf',
|
||||
coordinates: {
|
||||
latitude: 48.140364,
|
||||
longitude: 11.558735
|
||||
},
|
||||
products: { /* … */ }
|
||||
},
|
||||
arrival: '2017-11-13T09:39:00Z',
|
||||
|
||||
parts: [ {
|
||||
id: '1|1436339|0|80|12112017',
|
||||
|
||||
origin: {
|
||||
type: 'station',
|
||||
id: '8089100',
|
||||
name: 'Berlin Jungfernheide (S)',
|
||||
coordinates: {
|
||||
latitude: 52.530291,
|
||||
longitude: 13.299451
|
||||
},
|
||||
products: {
|
||||
nationalExp: false,
|
||||
national: false,
|
||||
regionalExp: false,
|
||||
regional: true,
|
||||
suburban: true,
|
||||
bus: true,
|
||||
ferry: false,
|
||||
subway: true,
|
||||
tram: false,
|
||||
taxi: false
|
||||
}
|
||||
},
|
||||
departure: '2017-11-13T00:50:00Z',
|
||||
departurePlatform: '6',
|
||||
|
||||
destination: {
|
||||
type: 'station',
|
||||
id: '8089047',
|
||||
name: 'Berlin Westkreuz',
|
||||
coordinates: {
|
||||
latitude: 52.500752,
|
||||
longitude: 13.283854
|
||||
},
|
||||
products: {
|
||||
nationalExp: false,
|
||||
national: false,
|
||||
regionalExp: false,
|
||||
regional: true,
|
||||
suburban: true,
|
||||
bus: true,
|
||||
ferry: false,
|
||||
subway: false,
|
||||
tram: false,
|
||||
taxi: false
|
||||
}
|
||||
},
|
||||
arrival: '2017-11-13T00:57:00Z',
|
||||
delay: 0,
|
||||
|
||||
line: {
|
||||
type: 'line',
|
||||
name: 'S 42',
|
||||
mode: 'train',
|
||||
product: 'suburban',
|
||||
class: 16,
|
||||
productCode: 4,
|
||||
productName: 's'
|
||||
},
|
||||
direction: 'Ringbahn <-',
|
||||
arrivalPlatform: '12'
|
||||
}, {
|
||||
id: '1|332491|0|80|12112017',
|
||||
|
||||
origin: { /* … */ },
|
||||
departure: '2017-11-13T01:05:00Z',
|
||||
departurePlatform: '3',
|
||||
|
||||
destination: { /* … */ },
|
||||
arrival: '2017-11-13T01:18:00Z',
|
||||
delay: 0,
|
||||
|
||||
line: { /* … */ },
|
||||
direction: 'Berlin Ostbahnhof'
|
||||
}, {
|
||||
origin: { /* … */ },
|
||||
departure: '2017-11-13T01:18:00Z',
|
||||
destination: { /* … */ },
|
||||
arrival: '2017-11-13T01:26:00Z',
|
||||
mode: 'walking'
|
||||
}, {
|
||||
/* … */
|
||||
} ]
|
||||
} ]
|
||||
```
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue