s2-tools/dist/readers/gtfs/schedule/frequencies.d.ts

A collection of geospatial tools primarily designed for WGS84, Web Mercator, and S2.

/**
 *
 * Indicates the type of service for a trip with frequencies:
 * 0 or empty = Frequency-based trips
 * 1 = Schedule-based trips (with identical headway)
 */
export declare enum GTFSExactTimes {
    FrequencyBased = 0,
    ScheduleBased = 1
}
/**
 * # Frequency
 *
 * **Optional**
 * Defines headway-based (or compressed schedule-based) service for specific trips.
 * Each record references a single trip and indicates:
 * - A start/end time window
 * - A headway (seconds between departures)
 * - Whether it’s frequency-based (exact_times=0) or schedule-based (exact_times=1).
 *
 * **Primary Key**: (`trip_id`, `start_time`)
 */
export declare class GTFSFrequency {
    /**
     * **Required**
     * Identifies the trip (`trips.trip_id`) to which the specified headway of service applies.
     */
    tripId: string;
    /**
     * **Required**
     * Time at which the first vehicle departs from the trip’s first stop
     * with the specified headway (HH:MM:SS, can exceed 24:00:00 if overnight).
     */
    startTime: string;
    /**
     * **Required**
     * Time at which service changes or ends (HH:MM:SS, can exceed 24:00:00 if overnight).
     */
    endTime: string;
    /**
     * **Required**
     * Headway in seconds between departures from the same stop for this trip,
     * during [start_time, end_time).
     */
    headwaySecs: number;
    /**
     * **Optional**
     * Whether this is frequency-based or schedule-based service.
     * - 0 or empty = Frequency-based
     * - 1 = Schedule-based
     */
    exactTimes?: GTFSExactTimes;
    /** @param data - the parsed GTFS CSV data */
    constructor(data: Record<string, string>);
}
/**
 * @param input - the input string to parse from
 * @returns - an array of Frequency
 */
export declare function parseGTFSFrequencies(input: string): GTFSFrequency[];
//# sourceMappingURL=frequencies.d.ts.map