ws-dottie
Version:
Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration
56 lines • 3.11 kB
TypeScript
import type { UseQueryResult } from "@tanstack/react-query";
import type { FetchFunctionParams, QueryHookOptions } from "../../types";
import { type AlertByIdInput } from "./shared/highwayAlerts.input";
import { type Alert } from "./shared/highwayAlerts.output";
/**
* Metadata for the fetchAlertById endpoint
*/
export declare const alertByIdMeta: {
functionName: string;
endpoint: string;
inputSchema: import("zod").ZodObject<{
AlertID: import("zod").ZodNumber;
}, import("zod/v4/core").$strip>;
outputSchema: import("zod").ZodObject<{
AlertID: import("zod").ZodInt;
County: import("zod").ZodNullable<import("zod").ZodString>;
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>>;
EndTime: import("zod").ZodNullable<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>>;
EventCategory: import("zod").ZodNullable<import("zod").ZodString>;
EventStatus: import("zod").ZodNullable<import("zod").ZodString>;
ExtendedDescription: import("zod").ZodNullable<import("zod").ZodString>;
HeadlineDescription: import("zod").ZodNullable<import("zod").ZodString>;
LastUpdatedTime: import("zod").ZodNullable<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>>;
Priority: import("zod").ZodNullable<import("zod").ZodString>;
Region: import("zod").ZodNullable<import("zod").ZodString>;
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>>;
StartTime: import("zod").ZodNullable<import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>>;
}, import("zod/v4/core").$strip>;
sampleParams: {
AlertID: number;
};
endpointDescription: string;
};
/**
* Fetch function for retrieving highway alert details for a specific alert ID
*/
export declare const fetchAlertById: (params?: FetchFunctionParams<AlertByIdInput>) => Promise<Alert>;
/**
* React Query hook for retrieving highway alert details for a specific alert ID
*/
export declare const useAlertById: (params?: FetchFunctionParams<AlertByIdInput>, options?: QueryHookOptions<Alert>) => UseQueryResult<Alert, Error>;
//# sourceMappingURL=alertById.d.ts.map