gtfs-stream/dist/index.d.ts

Streaming GTFS and GTFS-RT parser for node

import { Transform } from 'stream';
import { GtfsFiles, StopTime } from 'gtfs-types';
import { Entity } from 'gtfs-rt-bindings';

interface PlainOptions {
    raw?: boolean;
}
declare const _default$2: ({ raw }?: PlainOptions) => Transform;

declare const _default$1: () => Transform;

declare const _default: () => Transform;

/**
 * Mapping from GTFS numeric route types to human-readable string values
 */
declare const routeTypes: {
    '0': string;
    '1': string;
    '3': string;
    '4': string;
    '5': string;
    '6': string;
    '7': string;
    '100': string;
    '101': string;
    '102': string;
    '103': string;
    '104': string;
    '105': string;
    '106': string;
    '107': string;
    '108': string;
    '109': string;
    '110': string;
    '111': string;
    '112': string;
    '113': string;
    '114': string;
    '115': string;
    '116': string;
    '117': string;
    '200': string;
    '201': string;
    '202': string;
    '203': string;
    '204': string;
    '205': string;
    '206': string;
    '207': string;
    '208': string;
    '209': string;
    '300': string;
    '400': string;
    '401': string;
    '402': string;
    '403': string;
    '404': string;
    '405': string;
    '500': string;
    '600': string;
    '700': string;
    '701': string;
    '702': string;
    '703': string;
    '704': string;
    '705': string;
    '706': string;
    '707': string;
    '708': string;
    '709': string;
    '710': string;
    '711': string;
    '712': string;
    '713': string;
    '714': string;
    '715': string;
    '716': string;
    '717': string;
    '800': string;
    '900': string;
    '901': string;
    '902': string;
    '903': string;
    '904': string;
    '905': string;
    '906': string;
    '907': string;
    '1000': string;
    '1001': string;
    '1002': string;
    '1003': string;
    '1004': string;
    '1005': string;
    '1006': string;
    '1007': string;
    '1008': string;
    '1009': string;
    '1010': string;
    '1011': string;
    '1012': string;
    '1013': string;
    '1014': string;
    '1015': string;
    '1016': string;
    '1017': string;
    '1018': string;
    '1019': string;
    '1020': string;
    '1021': string;
    '1100': string;
    '1101': string;
    '1102': string;
    '1103': string;
    '1104': string;
    '1105': string;
    '1106': string;
    '1107': string;
    '1108': string;
    '1109': string;
    '1110': string;
    '1111': string;
    '1112': string;
    '1113': string;
    '1114': string;
    '1200': string;
    '1300': string;
    '1301': string;
    '1302': string;
    '1303': string;
    '1304': string;
    '1305': string;
    '1306': string;
    '1307': string;
    '1400': string;
    '1401': string;
    '1402': string;
    '1500': string;
    '1501': string;
    '1502': string;
    '1503': string;
    '1504': string;
    '1505': string;
    '1506': string;
    '1507': string;
    '1600': string;
    '1601': string;
    '1602': string;
    '1603': string;
    '1604': string;
    '1700': string;
};
/**
 * Define the type for the human-readable route types
 * This creates a union type of all the string values in the routeTypes object
 */
type EnhancedRouteType = (typeof routeTypes)[keyof typeof routeTypes];

/**
 * Mapping from GTFS numeric location types to human-readable string values
 */
declare const locationTypes: {
    '0': string;
    '1': string;
    '2': string;
    '3': string;
    '4': string;
};
/**
 * Define the type for the human-readable location types
 * This creates a union type of all the string values in the locationTypes object
 */
type EnhancedLocationType = (typeof locationTypes)[keyof typeof locationTypes];

declare const wheelchairTypes: {
    '0': string;
    '1': string;
    '2': string;
};
type EnhancedWheelchairBoardingType = (typeof wheelchairTypes)[keyof typeof wheelchairTypes];

type GtfsData = GtfsFiles[keyof GtfsFiles];
type GtfsRtObject = Entity;
type EnhancedGtfsData = GtfsData & {
    location_type?: EnhancedLocationType;
    wheelchair_boarding?: EnhancedWheelchairBoardingType;
    route_type?: EnhancedRouteType;
    schedule?: StopTime[];
    path?: {
        type: 'LineString';
        coordinates: [number, number][];
    };
};
interface GtfsObject {
    type: string;
    data: GtfsData;
}
interface EnhancedGtfsObject {
    type: string;
    data: EnhancedGtfsData;
}

export { EnhancedGtfsData, EnhancedGtfsObject, GtfsData, GtfsObject, GtfsRtObject, _default$2 as default, _default as enhanced, _default$2 as plain, _default$1 as rt };