ws-dottie
Version:
Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration
44 lines • 2.58 kB
TypeScript
import type { UseQueryResult } from "@tanstack/react-query";
import type { FetchFunctionParams, QueryHookOptions } from "../../types";
import { type BridgeClearancesInput } from "./shared/bridgeClearances.input";
import { type BridgeClearance } from "./shared/bridgeClearances.output";
/**
* Metadata for the fetchBridgeClearances endpoint
*/
export declare const bridgeClearancesMeta: {
functionName: string;
endpoint: string;
inputSchema: import("zod").ZodObject<{}, import("zod/v4/core").$strip>;
outputSchema: import("zod").ZodArray<import("zod").ZodObject<{
APILastUpdate: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>;
BridgeNumber: import("zod").ZodNullable<import("zod").ZodString>;
ControlEntityGuid: import("zod").ZodString;
CrossingDescription: import("zod").ZodNullable<import("zod").ZodString>;
CrossingLocationId: import("zod").ZodNumber;
CrossingRecordGuid: import("zod").ZodString;
InventoryDirection: import("zod").ZodNullable<import("zod").ZodString>;
Latitude: import("zod").ZodNumber;
LocationGuid: import("zod").ZodString;
Longitude: import("zod").ZodNumber;
RouteDate: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>;
SRMP: import("zod").ZodNumber;
SRMPAheadBackIndicator: import("zod").ZodNullable<import("zod").ZodString>;
StateRouteID: import("zod").ZodNullable<import("zod").ZodString>;
StateStructureId: import("zod").ZodNullable<import("zod").ZodString>;
VerticalClearanceMaximumFeetInch: import("zod").ZodNullable<import("zod").ZodString>;
VerticalClearanceMaximumInches: import("zod").ZodNumber;
VerticalClearanceMinimumFeetInch: import("zod").ZodNullable<import("zod").ZodString>;
VerticalClearanceMinimumInches: import("zod").ZodNumber;
}, import("zod/v4/core").$strip>>;
sampleParams: {};
endpointDescription: string;
};
/**
* Fetch function for retrieving vertical clearance data for all Washington State bridges
*/
export declare const fetchBridgeClearances: (params?: FetchFunctionParams<BridgeClearancesInput>) => Promise<BridgeClearance[]>;
/**
* React Query hook for retrieving vertical clearance data for all Washington State bridges
*/
export declare const useBridgeClearances: (params?: FetchFunctionParams<BridgeClearancesInput>, options?: QueryHookOptions<BridgeClearance[]>) => UseQueryResult<BridgeClearance[], Error>;
//# sourceMappingURL=bridgeClearances.d.ts.map