UNPKG

ws-dottie

Version:

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

43 lines 2.2 kB
import type { UseQueryResult } from "@tanstack/react-query"; import type { FetchFunctionParams, QueryHookOptions } from "../../types"; import { type RoutesByTripDateAndTerminalsInput } from "./shared/routes.input"; import { type Route } from "./shared/routes.output"; /** * Metadata for the fetchRoutesByTripDateAndTerminals endpoint */ export declare const routesByTripDateAndTerminalsMeta: { 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; ServiceDisruptions: import("zod").ZodNullable<import("zod").ZodArray<import("zod").ZodObject<{ BulletinID: import("zod").ZodNumber; BulletinFlag: import("zod").ZodBoolean; PublishDate: import("zod").ZodNullable<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>>; DisruptionDescription: 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 routes matching terminal pair for specified date */ export declare const fetchRoutesByTripDateAndTerminals: (params?: FetchFunctionParams<RoutesByTripDateAndTerminalsInput>) => Promise<Route[]>; /** * React Query hook for retrieving routes matching terminal pair for specified date */ export declare const useRoutesByTripDateAndTerminals: (params?: FetchFunctionParams<RoutesByTripDateAndTerminalsInput>, options?: QueryHookOptions<Route[]>) => UseQueryResult<Route[], Error>; //# sourceMappingURL=routesByTripDateAndTerminals.d.ts.map