Skip to content
Node API for MVG departures.
JavaScript
Branch: master
Clone or download
Latest commit ac8ab81 Jul 6, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
source Fixed faulty line number creation. Sep 28, 2018
test Adjusted test data so that it mirrors the real responses. Sep 27, 2018
.gitignore
.npmignore Forgot to change source folder name in npmignore. Nov 9, 2017
.travis.yml Another adjustement in the travis.yml. Mar 7, 2017
License.md Create License.md Feb 10, 2017
README.md Use better build badge. Jun 8, 2018
index.js Cleaned up code to get back to expected method and return values. Mar 19, 2018
package-lock.json Update more modules. Jul 6, 2019
package.json Update more modules. Jul 6, 2019
test.js Changed function calls in test.js so that they use the correct type a… Mar 19, 2018

README.md

mvg-api

Build Status

Node API for MVG departures.

Installation

npm install @lynbarry/mvg-api

Usage

The "getDepartures" function takes up to three parameters:

  • station: A String containing the name of the desired station.
  • transportTypes: A list of strings containing the types of transport that are supposed to be shown. (u = ubahn, s = sbahn, b = bus, t = tram)
  • apiRedirectUrl (Optional): A String containing the URL of a redirect endpoint. If given, the requests will be sent to apiRedirectUrl/mvgEndpoint. You may need this to get around CORS problems when making requests in the frontend. Defaults to the mvg-URL.

Example

const mvgApi = require('@lynbarry/mvg-api');

mvgApi.getDepartures('Harras', ['u', 's', 'b', 't']).then(lines => {
    console.log(lines);
});

Output is a list of departures:

[ { [Number: 0]
    lineNumber: '6',
    lineDestination: 'Klinikum Großhadern',
    lineDepartureIn: 0,
    lineType: 'u' },
  { [Number: 4]
    lineNumber: '6',
    lineDestination: 'Garching-Forschungszentrum',
    lineDepartureIn: 4,
    lineType: 'u' },
  { [Number: 11]
    lineNumber: '6',
    lineDestination: 'Klinikum Großhadern',
    lineDepartureIn: 11,
    lineType: 'u' },
    ...

You can also use the toString method to get a list in human readable form:

2	U6:	Garching-Forschungszentrum,
8	U6:	Klinikum Großhadern,
9	U6:	Fröttmaning,
13	U6:	Garching-Forschungszentrum,
15	U6:	Klinikum Großhadern,

Tests

npm test

Contributing

In lieu of a formal style guide, take care to maintain the existing coding style.
Add unit tests for any new or changed functionality. Lint and test your code. 
You can’t perform that action at this time.