ws-dottie
Version:
Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration
58 lines • 3.42 kB
TypeScript
import type { UseQueryResult } from "@tanstack/react-query";
import type { FetchFunctionParams, QueryHookOptions } from "../../types";
import { type ScheduleTodayByRouteInput } from "./shared/scheduleToday.input";
import { type Schedule } from "./shared/scheduleToday.output";
/**
* Metadata for the fetchScheduleTodayByRoute endpoint
*/
export declare const scheduleTodayByRouteMeta: {
functionName: string;
endpoint: string;
inputSchema: import("zod").ZodObject<{
RouteID: import("zod").ZodNumber;
OnlyRemainingTimes: import("zod").ZodBoolean;
}, import("zod/v4/core").$strip>;
outputSchema: import("zod").ZodObject<{
ScheduleID: import("zod").ZodNumber;
ScheduleName: import("zod").ZodString;
ScheduleSeason: import("zod").ZodUnion<readonly [import("zod").ZodLiteral<0>, import("zod").ZodLiteral<1>, import("zod").ZodLiteral<2>, import("zod").ZodLiteral<3>]>;
SchedulePDFUrl: import("zod").ZodString;
ScheduleStart: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>;
ScheduleEnd: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>;
AllRoutes: import("zod").ZodArray<import("zod").ZodNumber>;
TerminalCombos: import("zod").ZodArray<import("zod").ZodObject<{
DepartingTerminalID: import("zod").ZodNumber;
DepartingTerminalName: import("zod").ZodString;
ArrivingTerminalID: import("zod").ZodNumber;
ArrivingTerminalName: import("zod").ZodString;
SailingNotes: import("zod").ZodString;
Annotations: import("zod").ZodArray<import("zod").ZodString>;
Times: import("zod").ZodArray<import("zod").ZodObject<{
DepartingTime: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>;
ArrivingTime: import("zod").ZodNullable<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>>;
LoadingRule: import("zod").ZodUnion<readonly [import("zod").ZodLiteral<1>, import("zod").ZodLiteral<2>, import("zod").ZodLiteral<3>]>;
VesselID: import("zod").ZodNumber;
VesselName: import("zod").ZodString;
VesselHandicapAccessible: import("zod").ZodBoolean;
VesselPositionNum: import("zod").ZodNumber;
Routes: import("zod").ZodArray<import("zod").ZodNumber>;
AnnotationIndexes: import("zod").ZodArray<import("zod").ZodNumber>;
}, import("zod/v4/core").$strip>>;
AnnotationsIVR: import("zod").ZodArray<import("zod").ZodString>;
}, import("zod/v4/core").$strip>>;
}, import("zod/v4/core").$strip>;
sampleParams: {
RouteID: number;
OnlyRemainingTimes: false;
};
endpointDescription: string;
};
/**
* Fetch function for retrieving today's schedule for a specific route
*/
export declare const fetchScheduleTodayByRoute: (params?: FetchFunctionParams<ScheduleTodayByRouteInput>) => Promise<Schedule>;
/**
* React Query hook for retrieving today's schedule for a specific route
*/
export declare const useScheduleTodayByRoute: (params?: FetchFunctionParams<ScheduleTodayByRouteInput>, options?: QueryHookOptions<Schedule>) => UseQueryResult<Schedule, Error>;
//# sourceMappingURL=scheduleTodayByRoute.d.ts.map