ws-dottie
Version:
Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration
42 lines • 2.26 kB
TypeScript
import type { UseQueryResult } from "@tanstack/react-query";
import type { FetchFunctionParams, QueryHookOptions } from "../../types";
import { type TrafficFlowByIdInput } from "./shared/flowData.input";
import { type FlowData } from "./shared/flowData.output";
/**
* Metadata for the fetchTrafficFlowById endpoint
*/
export declare const trafficFlowByIdMeta: {
functionName: string;
endpoint: string;
inputSchema: import("zod").ZodObject<{
FlowDataID: import("zod").ZodNumber;
}, import("zod/v4/core").$strip>;
outputSchema: import("zod").ZodObject<{
FlowDataID: import("zod").ZodNumber;
FlowReadingValue: import("zod").ZodUnion<readonly [import("zod").ZodLiteral<0>, import("zod").ZodLiteral<1>, import("zod").ZodLiteral<2>, import("zod").ZodLiteral<3>, import("zod").ZodLiteral<4>, import("zod").ZodLiteral<5>]>;
FlowStationLocation: 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>>;
Region: import("zod").ZodNullable<import("zod").ZodString>;
StationName: import("zod").ZodNullable<import("zod").ZodString>;
Time: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>;
}, import("zod/v4/core").$strip>;
sampleParams: {
FlowDataID: number;
};
endpointDescription: string;
};
/**
* Fetch function for retrieving current traffic flow condition for a specific station by ID
*/
export declare const fetchTrafficFlowById: (params?: FetchFunctionParams<TrafficFlowByIdInput>) => Promise<FlowData>;
/**
* React Query hook for retrieving current traffic flow condition for a specific station by ID
*/
export declare const useTrafficFlowById: (params?: FetchFunctionParams<TrafficFlowByIdInput>, options?: QueryHookOptions<FlowData>) => UseQueryResult<FlowData, Error>;
//# sourceMappingURL=trafficFlowById.d.ts.map