traintrack v1.0.3

TrainTrack

Simple node.js module for scraping and parsing SydneyTrains timetable data for analysis.

Install

$ npm install traintrack

Usage

var tt = require('traintrack');

Example

This example code extracts timetable data for the "North Shore & Northern Line", in the "Berowra to Parramatta"-direction, and then converts it into CSV format.

tt.getBody('ns', 0, function(html){
    tt.parseBody(html, function(data){
        tt.toCSV(data, function(string){
            console.log(string);
        });
    });
});

Timetables

Currently supported timetables for querying.

Data Format

• All stations are enumerated from stations.json.
• The data object holds two arrays, stations and times, respectively.
• Times are stored as rows per station, each row is equal in length.

{
	// array of stations
	s: [ "Station1", "Station2", ... ]
	// multidimensional array of times
	t: [ [ "00:00", "00:10", ... ], ... ]
}

API Reference

Retrieve a Timetable

• line (string): Code of timetable to retrieve (refer to above table.)
• direction (integer): 0 or 1 for timetable train direction.
• callback (function(html)): Callback returns html body through html parameter.

tt.getBody(line, direction, callback(html));

Parse the HTML

• html (string): HTML body of timetable source..
• callback (function(data)): Callback returns object of parsed timetable source through data parameter.

tt.parseBody(html, callback(data));

Output as CSV

• data (object): Data object returned from HTML parsing.
• callback (function(data)): Callback returns the CSV encoded string of object through string parameter.

tt.toCSV(data, callback(string));