https://github.com/derhuerst/discover-vbb-stations
Discover VBB stations by querying departures.
https://github.com/derhuerst/discover-vbb-stations
berlin graph public-transport stations transit vbb
Last synced: 4 months ago
JSON representation
Discover VBB stations by querying departures.
- Host: GitHub
- URL: https://github.com/derhuerst/discover-vbb-stations
- Owner: derhuerst
- License: isc
- Created: 2017-08-18T16:57:06.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-04-13T16:29:31.000Z (about 6 years ago)
- Last Synced: 2025-02-07T19:48:05.588Z (over 1 year ago)
- Topics: berlin, graph, public-transport, stations, transit, vbb
- Language: JavaScript
- Homepage: https://github.com/derhuerst/discover-vbb-stations
- Size: 18.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# discover-vbb-stations
**Discover [VBB](https://en.wikipedia.org/wiki/Verkehrsverbund_Berlin-Brandenburg) stations by querying departures.** It tries to find all stations that all trains known by VBB stop at. Analogous to [`discover-db-stations`](https://github.com/derhuerst/discover-db-stations).
[](https://www.npmjs.com/package/discover-vbb-stations)
[](https://travis-ci.org/derhuerst/discover-vbb-stations)
[](https://gitter.im/derhuerst)
[](https://patreon.com/derhuerst)
## Installing
```shell
npm install discover-vbb-stations
```
## Usage
### using the command line
Using [npx](https://www.npmjs.com/package/npx):
```shell
npx discover-vbb-stations [station-id] >stations.ndjson
```
### using JavaScript
```js
const walk = require('discover-vbb-stations')
walk(stationId) // where to start
.on('data', console.log)
.on('error', console.error)
```
`walk()` returns a [readable stream](http://nodejs.org/api/stream.html#stream_class_stream_readable) [in object mode](https://nodejs.org/api/stream.html#stream_object_mode). It emits the following events:
- `data`: a new station that has been discovered
- `stats`: an object with the following keys:
- `stations`: the number of stations discovered
- `requests`: the number of requests sent
- `queued`: the number of queued station IDs
- `edge`: a connection between two stations, with the following keys:
- `source`: a [*Friendly Public Transport Format* `1.0.1` `station` object](https://github.com/public-transport/friendly-public-transport-format/blob/1.0.1/spec/readme.md#station)
- `target`: a [*Friendly Public Transport Format* `1.0.1` `station` object](https://github.com/public-transport/friendly-public-transport-format/blob/1.0.1/spec/readme.md#station)
- `duration`: time to travel, in milliseconds
- `line`: an [vbb-hafas `line` object](https://github.com/derhuerst/vbb-hafas/blob/master/docs/journeys.md#response)
## API
```js
walk(stationId, [opt])
```
`stationId` must be a string and a valid [IBNR](https://de.wikipedia.org/wiki/Internationale_Bahnhofsnummer).
`opt` may have the following keys. It will be passed into [`queue()`](https://github.com/jessetane/queue#constructor).
- `concurrency`: number of requests run in parallel – default: `2`
- `timeout`: timeout for a single job in milliseconds – default: `10000`
## Contributing
If you **have a question**, **found a bug** or want to **propose a feature**, have a look at [the issues page](https://github.com/derhuerst/discover-vbb-stations/issues).