@lynbarry/mvg-api
Node API for MVG departures.
Last updated a month ago by lynbarry .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @lynbarry/mvg-api 
SYNC missed versions from official npm registry.

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. 

Current Tags

  • 3.2.0                                ...           latest (a month ago)

14 Versions

  • 3.2.0                                ...           a month ago
  • 3.1.0                                ...           7 months ago
  • 3.0.2                                ...           2 years ago
  • 3.0.1                                ...           2 years ago
  • 3.0.0                                ...           2 years ago
  • 2.0.1                                ...           3 years ago
  • 2.0.0                                ...           3 years ago
  • 1.1.0                                ...           3 years ago
  • 1.0.2                                ...           3 years ago
  • 1.0.1                                ...           3 years ago
  • 1.0.0                                ...           3 years ago
  • 0.0.3                                ...           3 years ago
  • 0.0.2                                ...           3 years ago
  • 0.0.1                                ...           3 years ago
Maintainers (1)
Downloads
Today 0
This Week 3
This Month 9
Last Day 0
Last Week 2
Last Month 23
Dependencies (2)
Dev Dependencies (4)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |