Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lsjroberts/node-tfl
UNFINISHED - Transport for London (TFL) node package
https://github.com/lsjroberts/node-tfl
Last synced: 6 days ago
JSON representation
UNFINISHED - Transport for London (TFL) node package
- Host: GitHub
- URL: https://github.com/lsjroberts/node-tfl
- Owner: lsjroberts
- License: mit
- Created: 2014-07-24T22:50:48.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-03-11T13:01:36.000Z (over 8 years ago)
- Last Synced: 2024-04-15T22:39:33.696Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 14.6 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# TFL - Node
This is a node package for interacting with the [Transport for London](http://tfl.co.uk) (TFL) api.
It comes with a tool for accessing this data directly via the command line, or can be used within your own projects.
## Installation
Install with:
```
$ npm install -g tfl
```
_move binary to /usr/local/bin ?_
## Command-line Tool
### Tube
**Line Status**
```
$ tfl tube --line District
```
**Station Status**
```
$ tfl tube --station Aldgate East
```
### Overground (Work in Progress)
```
$ tfl overground --station London Bridge
```
### Buses (Work in Progress)
```
$ tfl bus --route 66
```
### Cycle Hire (Work in Progress)
```
$ tfl cycle ...
```
### Roads (Work in Progress)
**Road Status**
```
$ tfl road --name Park Lane
```
**Route Status**
This will perform a search for the typical route taken between two roads and retrieve the statuses for each road on the route.
```
$ tfl road --from "Whitechapel Road" --to "Park Lane"
```
**Road Traffic Cam**
```
$ tfl road --camera Park Lane
```
## Using the package in your own projects
Require the tfl package as usual:
```js
var tfl = require('tfl');
```
Since each command sends a request to the TFL api, the response is returned in a promise. For example, to get the current list of incidents on tube lines you can call:
```js
tfl.tube.status({
'incidents': true,
}).then(function(lines) {
console.log(lines);
});
```
The function passed into `then()` will be called asynchronously once the request to the api has returned and been processed.
### Services
#### Tube / Overground
**Status**
```js
tfl.tube.status();
tfl.overground.status();
```
**Incidents**
```js
tfl.tube.status({ 'incidents': true });
tfl.overground.status({ 'incidents': true });
```
**Line (Work in Progress)**
```js
tfl.tube.line('District');
// Overground services do not provide line information
```
**Station (Work in Progress)**
```js
tfl.tube.station('Aldgate East');
tfl.overground.station('London Bridge');
```
**Arrivals (Work in Progress)**
```js
tfl.tube.arrivals('Aldgate East');
// overground?
```
**Journey (Work in Progress)**
```js
tfl.tube.journey(['Monument', 'Aldgate East']);
tfl.overground.journey(['East Croydon', 'Victoria', 'Shoreditch High Street']);
```
#### Bus
...
#### Cycle
...
#### Road
...