@golemio/pid
Version:
Golemio PID Module
27 lines (26 loc) • 1.19 kB
TypeScript
import { GTFSRouteTypeEnum } from "../../helpers/RouteTypeEnums";
type MinimalDeparture = {
route_type: GTFSRouteTypeEnum;
platform_code: string | null;
};
type PossiblyStopTime = {
cis_stop_platform_code: string | null;
} | null;
export declare class PlatformCodeResolver {
/**
* Platform code is determined by the following rules:
* - for trains, the last stop platform code is used (CIS) if available
* - otherwise, the departure platform code is used (GTFS)
* - for other route types, the departure platform code is used (GTFS)
* @param departure Must have `route_type` and `platform_code` properties
* @param cisStopPlatformCode For trains - this is where the `cis_stop_platform_code` goes
*/
static resolveDirect(departure: MinimalDeparture, cisStopPlatformCode: string | null): string | null;
/**
* Determine platform code based on the following rules:
* if current stop time is known, use its RT CIS platform code (if available)
* otherwise use GTFS schedule platform code
*/
static fromStopTimeCisShort(departure: MinimalDeparture, stopTime: PossiblyStopTime): string | null;
}
export {};