ws-dottie
Version:
Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration
48 lines • 2.56 kB
TypeScript
import type { UseQueryResult } from "@tanstack/react-query";
import type { FetchFunctionParams, QueryHookOptions } from "../../types";
import { type TravelTimesInput } from "./shared/travelTimeRoutes.input";
import { type TravelTimeRoute } from "./shared/travelTimeRoutes.output";
/**
* Metadata for the fetchTravelTimes endpoint
*/
export declare const travelTimesMeta: {
functionName: string;
endpoint: string;
inputSchema: import("zod").ZodObject<{}, import("zod/v4/core").$strip>;
outputSchema: import("zod").ZodArray<import("zod").ZodObject<{
AverageTime: import("zod").ZodNumber;
CurrentTime: import("zod").ZodNumber;
Description: import("zod").ZodNullable<import("zod").ZodString>;
Distance: import("zod").ZodNumber;
EndPoint: import("zod").ZodNullable<import("zod").ZodObject<{
Description: import("zod").ZodNullable<import("zod").ZodString>;
Direction: import("zod").ZodNullable<import("zod").ZodString>;
Latitude: import("zod").ZodNumber;
Longitude: import("zod").ZodNumber;
MilePost: import("zod").ZodNumber;
RoadName: import("zod").ZodNullable<import("zod").ZodString>;
}, import("zod/v4/core").$strip>>;
Name: import("zod").ZodNullable<import("zod").ZodString>;
StartPoint: import("zod").ZodNullable<import("zod").ZodObject<{
Description: import("zod").ZodNullable<import("zod").ZodString>;
Direction: import("zod").ZodNullable<import("zod").ZodString>;
Latitude: import("zod").ZodNumber;
Longitude: import("zod").ZodNumber;
MilePost: import("zod").ZodNumber;
RoadName: import("zod").ZodNullable<import("zod").ZodString>;
}, import("zod/v4/core").$strip>>;
TimeUpdated: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>;
TravelTimeID: import("zod").ZodNumber;
}, import("zod/v4/core").$strip>>;
sampleParams: {};
endpointDescription: string;
};
/**
* Fetch function for retrieving travel time data for all available routes
*/
export declare const fetchTravelTimes: (params?: FetchFunctionParams<TravelTimesInput>) => Promise<TravelTimeRoute[]>;
/**
* React Query hook for retrieving travel time data for all available routes
*/
export declare const useTravelTimes: (params?: FetchFunctionParams<TravelTimesInput>, options?: QueryHookOptions<TravelTimeRoute[]>) => UseQueryResult<TravelTimeRoute[], Error>;
//# sourceMappingURL=travelTimes.d.ts.map