UNPKG

ws-dottie

Version:

Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration

56 lines 3.13 kB
import type { UseQueryResult } from "@tanstack/react-query"; import type { FetchFunctionParams, QueryHookOptions } from "../../types"; import { type RouteDetailsByTripDateAndTerminalsInput } from "./shared/routeDetails.input"; import { type RouteDetail } from "./shared/routeDetails.output"; /** * Metadata for the fetchRouteDetailsByTripDateAndTerminals endpoint */ export declare const routeDetailsByTripDateAndTerminalsMeta: { functionName: string; endpoint: string; inputSchema: import("zod").ZodObject<{ TripDate: import("zod").ZodString; DepartingTerminalID: import("zod").ZodNumber; ArrivingTerminalID: import("zod").ZodNumber; }, import("zod/v4/core").$strip>; outputSchema: import("zod").ZodArray<import("zod").ZodObject<{ RouteID: import("zod").ZodNumber; RouteAbbrev: import("zod").ZodNullable<import("zod").ZodString>; Description: import("zod").ZodNullable<import("zod").ZodString>; RegionID: import("zod").ZodNumber; VesselWatchID: import("zod").ZodNumber; ReservationFlag: import("zod").ZodBoolean; InternationalFlag: import("zod").ZodBoolean; PassengerOnlyFlag: import("zod").ZodBoolean; CrossingTime: import("zod").ZodNullable<import("zod").ZodString>; AdaNotes: import("zod").ZodNullable<import("zod").ZodString>; GeneralRouteNotes: import("zod").ZodNullable<import("zod").ZodString>; SeasonalRouteNotes: import("zod").ZodNullable<import("zod").ZodString>; Alerts: import("zod").ZodArray<import("zod").ZodObject<{ BulletinID: import("zod").ZodNumber; BulletinFlag: import("zod").ZodBoolean; CommunicationFlag: import("zod").ZodBoolean; PublishDate: import("zod").ZodNullable<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>>; AlertDescription: import("zod").ZodNullable<import("zod").ZodString>; DisruptionDescription: import("zod").ZodNullable<import("zod").ZodString>; AlertFullTitle: import("zod").ZodString; AlertFullText: import("zod").ZodNullable<import("zod").ZodString>; IVRText: import("zod").ZodNullable<import("zod").ZodString>; }, import("zod/v4/core").$strip>>; }, import("zod/v4/core").$strip>>; sampleParams: { TripDate: string; DepartingTerminalID: number; ArrivingTerminalID: number; }; endpointDescription: string; }; /** * Fetch function for retrieving detailed route information for terminal pair on date */ export declare const fetchRouteDetailsByTripDateAndTerminals: (params?: FetchFunctionParams<RouteDetailsByTripDateAndTerminalsInput>) => Promise<RouteDetail[]>; /** * React Query hook for retrieving detailed route information for terminal pair on date */ export declare const useRouteDetailsByTripDateAndTerminals: (params?: FetchFunctionParams<RouteDetailsByTripDateAndTerminalsInput>, options?: QueryHookOptions<RouteDetail[]>) => UseQueryResult<RouteDetail[], Error>; //# sourceMappingURL=routeDetailsByTripDateAndTerminals.d.ts.map