https://github.com/derhuerst/discover-db-stations

Build a graph of DB stations by querying departures.
https://github.com/derhuerst/discover-db-stations

db deutsche-bahn transit transport

Last synced: 6 days ago
JSON representation

Build a graph of DB stations by querying departures.

• Host: GitHub
• URL: https://github.com/derhuerst/discover-db-stations
• Owner: derhuerst
• License: isc
• Created: 2017-02-26T23:41:26.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-09-01T15:59:15.000Z (about 6 years ago)
• Last Synced: 2024-10-03T23:55:25.713Z (about 1 month ago)
• Topics: db, deutsche-bahn, transit, transport
• Language: JavaScript
• Homepage: https://github.com/derhuerst/discover-db-stations
• Size: 27.3 KB
• Stars: 3
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

README

        
# discover-db-stations

**Discover [Deutsche Bahn](http://db.de/) stations by querying departures.** It tries to find all stations that all trains known by Deutsche Bahn stop at. Analogous to [`discover-vbb-stations`](https://github.com/derhuerst/discover-vbb-stations).

[![npm version](https://img.shields.io/npm/v/discover-db-stations.svg)](https://www.npmjs.com/package/discover-db-stations)

[![build status](https://img.shields.io/travis/derhuerst/discover-db-stations.svg)](https://travis-ci.org/derhuerst/discover-db-stations)

![ISC-licensed](https://img.shields.io/github/license/derhuerst/discover-db-stations.svg)

[![chat on gitter](https://badges.gitter.im/derhuerst.svg)](https://gitter.im/derhuerst)

[![support me on Patreon](https://img.shields.io/badge/support%20me-on%20patreon-fa7664.svg)](https://patreon.com/derhuerst)

## Installing

```shell

npm install discover-db-stations

```

## Usage

### using the command line

Using [npx](https://www.npmjs.com/package/npx):

```shell

npx discover-db-stations  >stations.ndjson

```

### using JavaScript

```js

const walk = require('discover-db-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.2.0` `station` object](https://github.com/public-transport/friendly-public-transport-format/blob/1.2.0/spec/readme.md#station)

	- `target`: a [*Friendly Public Transport Format* `1.2.0` `station` object](https://github.com/public-transport/friendly-public-transport-format/blob/1.2.0/spec/readme.md#station)

	- `duration`: time to travel, in milliseconds

	- `line`: an [db-hafas `line` object](https://github.com/derhuerst/db-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-db-stations/issues).