Right Track Agency: Long Island Rail Road (lirr)
Clone or download
Latest commit 6e7eaf6 Dec 19, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
db-build rt_links: change separator May 10, 2018
doc Update Docs Feb 20, 2018
src Feed: Unknown Trip - use undefined properties Mar 31, 2018
static DB Update: 2018121816 Dec 19, 2018
.gitignore Remove package-lock.json from repo Jan 15, 2018
.npmignore Ignore db-build gtfs/*.txt and out/ Dec 10, 2017
LICENSE Add License Feb 15, 2018
README.md Update Docs Jan 10, 2018
agency.json Mobile Images Mar 31, 2018
jsdoc.json Removed jsdoc template from config Sep 19, 2017
package.json Update Pakcage Deps Nov 7, 2018

README.md

Long Island Rail Road

node module: right-track-agency-lirr
GitHub repo: right-track/right-track-agency-lirr


This module is an implementation of a right-track-agency used to add agency-specific configuration and functionality to various Right Track Projects.

Features

This module provides the following agency-specific information:

  • Build Scripts for creating a Right Track Database for LIRR (using the right-track-db-build project)
  • The latest compiled Right Track Database for LIRR
  • The archived Right Track Databases for LIRR
  • Agency configuration properties to be used in various Right Track projects
  • The functions to generate a LIRR Station Feed for the right-track-server

Documentation

Documentation can be found in the /doc/ directory of this repository or online at https://docs.righttrack.io/right-track-agency-lirr.

Additional documentation about the RightTrackAgency class can be found in the right-track-agency project and online at https://docs.righttrack.io/right-track-agency.

Usage

On require the module will return a new instance of the Long Island Rail Road implementation of a RightTrackAgency Class.

To get the agency configuration properties:

const LIRR = require('right-track-agency-lirr');

// Optionally load an additional configuration file
LIRR.readConfig('/path/to/config.json');

// Get the merged configuration
let config = LIRR.getConfig();

To get the real-time StationFeed for Jamaica Station:

const core = require('right-track-core');
const RightTrackDB = require('right-track-db-sqlite3');
const LIRR = require('right-track-agency-lirr');

// Set up the Right Track DB for LIRR
let db = new RightTrackDB(LIRR);

// Get the Stop for Jamaica (id='15') by querying the RightTrackDB
core.query.stops.getStop(db, '15', function(err, stop) {

  // Load the StationFeed for Jamaica
  LIRR.loadFeed(db, stop, function(err, feed) {

    // Do something with the feed
    console.log(feed);

  });

});