ws-dottie
Version:
Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration
36 lines • 1.96 kB
TypeScript
import type { UseQueryResult } from "@tanstack/react-query";
import type { FetchFunctionParams, QueryHookOptions } from "../../types";
import { type BorderCrossingsInput } from "./shared/borderCrossingData.input";
import { type BorderCrossing } from "./shared/borderCrossingData.output";
/**
* Metadata for the fetchBorderCrossings endpoint
*/
export declare const borderCrossingsMeta: {
functionName: string;
endpoint: string;
inputSchema: import("zod").ZodObject<{}, import("zod/v4/core").$strip>;
outputSchema: import("zod").ZodArray<import("zod").ZodObject<{
BorderCrossingLocation: 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>>;
CrossingName: import("zod").ZodNullable<import("zod").ZodString>;
Time: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>;
WaitTime: import("zod").ZodInt;
}, import("zod/v4/core").$strip>>;
sampleParams: {};
endpointDescription: string;
};
/**
* Fetch function for retrieving current wait times for all Washington border crossings into Canada
*/
export declare const fetchBorderCrossings: (params?: FetchFunctionParams<BorderCrossingsInput>) => Promise<BorderCrossing[]>;
/**
* React Query hook for retrieving current wait times for all Washington border crossings into Canada
*/
export declare const useBorderCrossings: (params?: FetchFunctionParams<BorderCrossingsInput>, options?: QueryHookOptions<BorderCrossing[]>) => UseQueryResult<BorderCrossing[], Error>;
//# sourceMappingURL=borderCrossings.d.ts.map