UNPKG

ws-dottie

Version:

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

51 lines 2.85 kB
import type { UseQueryResult } from "@tanstack/react-query"; import type { FetchFunctionParams, QueryHookOptions } from "../../types"; import { type ScheduledRoutesByIdInput } from "./shared/scheduledRoutes.input"; import { type SchedRoute } from "./shared/scheduledRoutes.output"; /** * Metadata for the fetchScheduledRoutesById endpoint */ export declare const scheduledRoutesByIdMeta: { functionName: string; endpoint: string; inputSchema: import("zod").ZodObject<{ ScheduleID: import("zod").ZodOptional<import("zod").ZodNumber>; }, import("zod/v4/core").$strip>; outputSchema: import("zod").ZodArray<import("zod").ZodObject<{ ScheduleID: import("zod").ZodNumber; SchedRouteID: import("zod").ZodNumber; ContingencyOnly: import("zod").ZodBoolean; RouteID: import("zod").ZodNumber; RouteAbbrev: import("zod").ZodString; Description: import("zod").ZodString; SeasonalRouteNotes: import("zod").ZodNullable<import("zod").ZodString>; RegionID: import("zod").ZodNumber; ServiceDisruptions: 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>>; ContingencyAdj: import("zod").ZodArray<import("zod").ZodObject<{ DateFrom: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>; DateThru: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>; EventID: import("zod").ZodNullable<import("zod").ZodNumber>; EventDescription: import("zod").ZodNullable<import("zod").ZodString>; AdjType: import("zod").ZodUnion<readonly [import("zod").ZodLiteral<1>, import("zod").ZodLiteral<2>]>; ReplacedBySchedRouteID: import("zod").ZodNullable<import("zod").ZodNumber>; }, import("zod/v4/core").$strip>>; }, import("zod/v4/core").$strip>>; sampleParams: { ScheduleID: number; }; endpointDescription: string; }; /** * Fetch function for retrieving scheduled routes for a specific schedule season */ export declare const fetchScheduledRoutesById: (params?: FetchFunctionParams<ScheduledRoutesByIdInput>) => Promise<SchedRoute[]>; /** * React Query hook for retrieving scheduled routes for a specific schedule season */ export declare const useScheduledRoutesById: (params?: FetchFunctionParams<ScheduledRoutesByIdInput>, options?: QueryHookOptions<SchedRoute[]>) => UseQueryResult<SchedRoute[], Error>; //# sourceMappingURL=scheduledRoutesById.d.ts.map