UNPKG

ws-dottie

Version:

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

68 lines 4.34 kB
import type { UseQueryResult } from "@tanstack/react-query"; import type { FetchFunctionParams, QueryHookOptions } from "../../types"; import { type CommercialVehicleRestrictionsInput } from "./shared/cvRestrictionData.input"; import { type CVRestriction } from "./shared/cvRestrictionData.output"; /** * Metadata for the fetchCommercialVehicleRestrictions endpoint */ export declare const commercialVehicleRestrictionsMeta: { functionName: string; endpoint: string; inputSchema: import("zod").ZodObject<{}, import("zod/v4/core").$strip>; outputSchema: import("zod").ZodArray<import("zod").ZodObject<{ BLMaxAxle: import("zod").ZodNullable<import("zod").ZodNumber>; BridgeName: import("zod").ZodNullable<import("zod").ZodString>; BridgeNumber: import("zod").ZodNullable<import("zod").ZodString>; CL8MaxAxle: import("zod").ZodNullable<import("zod").ZodNumber>; DateEffective: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>; DateExpires: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>; DatePosted: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>; EndRoadwayLocation: 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>>; IsDetourAvailable: import("zod").ZodBoolean; IsExceptionsAllowed: import("zod").ZodBoolean; IsPermanentRestriction: import("zod").ZodBoolean; IsWarning: import("zod").ZodBoolean; Latitude: import("zod").ZodNumber; LocationDescription: import("zod").ZodNullable<import("zod").ZodString>; LocationName: import("zod").ZodNullable<import("zod").ZodString>; Longitude: import("zod").ZodNumber; MaximumGrossVehicleWeightInPounds: import("zod").ZodNullable<import("zod").ZodNumber>; RestrictionComment: import("zod").ZodNullable<import("zod").ZodString>; RestrictionHeightInInches: import("zod").ZodNullable<import("zod").ZodNumber>; RestrictionLengthInInches: import("zod").ZodNullable<import("zod").ZodNumber>; RestrictionType: import("zod").ZodNumber; RestrictionWeightInPounds: import("zod").ZodNullable<import("zod").ZodNumber>; RestrictionWidthInInches: import("zod").ZodNullable<import("zod").ZodNumber>; SAMaxAxle: import("zod").ZodNullable<import("zod").ZodNumber>; StartRoadwayLocation: 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>>; State: import("zod").ZodNullable<import("zod").ZodString>; StateRouteID: import("zod").ZodNullable<import("zod").ZodString>; TDMaxAxle: import("zod").ZodNullable<import("zod").ZodNumber>; VehicleType: import("zod").ZodNullable<import("zod").ZodString>; }, import("zod/v4/core").$strip>>; sampleParams: {}; endpointDescription: string; }; /** * Fetch function for retrieving commercial vehicle restrictions for all Washington State highways */ export declare const fetchCommercialVehicleRestrictions: (params?: FetchFunctionParams<CommercialVehicleRestrictionsInput>) => Promise<CVRestriction[]>; /** * React Query hook for retrieving commercial vehicle restrictions for all Washington State highways */ export declare const useCommercialVehicleRestrictions: (params?: FetchFunctionParams<CommercialVehicleRestrictionsInput>, options?: QueryHookOptions<CVRestriction[]>) => UseQueryResult<CVRestriction[], Error>; //# sourceMappingURL=commercialVehicleRestrictions.d.ts.map