brendan/project-inter-server
1
0
Fork 0
mirror of https://github.com/brendan-ch/project-inter-server.git synced 2026-04-19 08:50:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

update documentation and return types for repository

Browse Source
This commit is contained in:
Brendan Chen
2024-12-22 14:06:13 -08:00
parent b43666b956
commit e3d6d71825
1 changed files with 19 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
src/repository.ts
View File

@@ -55,24 +55,37 @@ export interface Repository {
// Getter methods // Getter methods
getSystems(): Promise<ISystem[]>; getSystems(): Promise<ISystem[]>;
getSystemById(systemId: string): Promise<ISystem>; getSystemById(systemId: string): Promise<ISystem | null>;
getStopsBySystemId(systemId: string): Promise<IStop[]>; getStopsBySystemId(systemId: string): Promise<IStop[]>;
getStopById(stopId: string): Promise<IStop[]>; getStopById(stopId: string): Promise<IStop | null>;
getRoutesBySystemId(systemId: string): Promise<IRoute[]>; getRoutesBySystemId(systemId: string): Promise<IRoute[]>;
getRouteById(routeId: string): Promise<IRoute>; getRouteById(routeId: string): Promise<IRoute | null>;
getShuttlesBySystemId(systemId: string): Promise<IShuttle[]>; getShuttlesBySystemId(systemId: string): Promise<IShuttle[]>;
getShuttleById(shuttleId: string): Promise<IShuttle[]>; getShuttleById(shuttleId: string): Promise<IShuttle | null>;
getEtasForShuttleId(shuttleId: string): Promise<IEta[]>; getEtasForShuttleId(shuttleId: string): Promise<IEta[]>;
getEtasForStopId(stopId: string): Promise<IEta[]>; getEtasForStopId(stopId: string): Promise<IEta[]>;
getEtaForShuttleAndStopId(shuttleId: string, stopId: string): Promise<IEta[]>; getEtaForShuttleAndStopId(shuttleId: string, stopId: string): Promise<IEta | null>;
getOrderedStopByRouteAndStopId(routeId: string, stopId: string): Promise<IOrderedStop[]>; getOrderedStopByRouteAndStopId(routeId: string, stopId: string): Promise<IOrderedStop | null>;
/**
* Get ordered stops with the given stop ID.
* Returns an empty array if no ordered stops found.
* @param stopId
*/
getOrderedStopsByStopId(stopId: string): Promise<IOrderedStop[]>; getOrderedStopsByStopId(stopId: string): Promise<IOrderedStop[]>;
/**
* Get ordered stops with the given route ID.
* Returns an empty array if no ordered stops found.
* @param routeId
*/
getOrderedStopsByRouteId(routeId: string): Promise<IOrderedStop[]>; getOrderedStopsByRouteId(routeId: string): Promise<IOrderedStop[]>;
getNextOrderedStopFromOrderedStopId(stopId: string): Promise<IOrderedStop | null>; getNextOrderedStopFromOrderedStopId(stopId: string): Promise<IOrderedStop | null>;
getPreviousOrderedStopFromOrderedStopId(stopId: string): Promise<IOrderedStop | null>; getPreviousOrderedStopFromOrderedStopId(stopId: string): Promise<IOrderedStop | null>;