tfl-api-wrapper
Version:
A Node JS wrapper for the Transport for London API
23 lines (22 loc) • 914 B
TypeScript
import TfLAPI from './tfl';
import ICrowding from './interfaces/crowding';
import DaysOfTheWeek from './enums/DaysOfTheWeek';
export default class Crowding extends TfLAPI {
constructor(config: string);
/**
* Get crowding information for Naptan
* @param naptanID ID of the stop (eg. 940GZZLUASL)
*/
getAllByNaptan(naptanID: string): Promise<ICrowding.Root>;
/**
* Get crowding information for Naptan for a specified day of week
* @param naptanID ID of the stop (eg. 940GZZLUASL)
* @param dayOfTheWeek The day of which you would like data to return (eg. MON, TUE)
*/
getByNaptanDay(naptanID: string, dayOfTheWeek: DaysOfTheWeek): Promise<ICrowding.Root>;
/**
* Get live crowding information for Naptan
* @param naptanID ID of the stop (eg. 940GZZLUASL)
*/
getLiveByNaptan(naptan: string): Promise<ICrowding.Live>;
}