minotor
Version:
A lightweight client-side transit routing library.
25 lines (24 loc) • 1.18 kB
TypeScript
import { RouteType, ServiceRoute, ServiceRouteId } from '../timetable/timetable.js';
import { GtfsProfile } from './parser.js';
export type GtfsRouteType = number;
export type GtfsRouteId = string;
export type GtfsRoutesMap = Map<GtfsRouteId, {
name: string;
type: RouteType;
}>;
/**
* Parses a GTFS routes.txt file and returns a map of all the valid routes.
*
* @param routesStream A readable stream for the GTFS routes.txt file.
* @param profile A configuration object defining the specificities of the GTFS feed.
* @returns A map of all the valid routes.
*/
export declare const parseRoutes: (routesStream: NodeJS.ReadableStream, profile?: GtfsProfile) => Promise<GtfsRoutesMap>;
/**
* Creates an array of ServiceRoute objects by combining GTFS route data with service route mappings.
*
* @param gtfsRoutesMap A map containing GTFS route information indexed by route ID
* @param serviceRoutesMap A map linking GTFS route IDs to service route IDs
* @returns An array of ServiceRoute objects with route information
*/
export declare const indexRoutes: (gtfsRoutesMap: GtfsRoutesMap, serviceRoutesMap: Map<GtfsRouteId, ServiceRouteId>) => ServiceRoute[];