ws-dottie/dist/apis/wsdot-highway-alerts/highwayAlerts/searchAlerts.d.ts

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

import type { UseQueryResult } from "@tanstack/react-query";
import type { FetchFunctionParams, QueryHookOptions } from "../../types";
import { type SearchAlertsInput } from "./shared/highwayAlerts.input";
import { type Alert } from "./shared/highwayAlerts.output";
/**
 * Metadata for the searchAlerts endpoint
 */
export declare const searchAlertsMeta: {
    functionName: string;
    endpoint: string;
    inputSchema: import("zod").ZodObject<{
        StateRoute: import("zod").ZodOptional<import("zod").ZodString>;
        Region: import("zod").ZodOptional<import("zod").ZodInt>;
        SearchTimeStart: import("zod").ZodOptional<import("zod").ZodString>;
        SearchTimeEnd: import("zod").ZodOptional<import("zod").ZodString>;
        StartingMilepost: import("zod").ZodOptional<import("zod").ZodNumber>;
        EndingMilepost: import("zod").ZodOptional<import("zod").ZodNumber>;
    }, import("zod/v4/core").$strip>;
    outputSchema: import("zod").ZodArray<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: {
        StateRoute: string;
        StartingMilepost: number;
        EndingMilepost: number;
        SearchTimeStart: string;
        SearchTimeEnd: string;
    };
    endpointDescription: string;
};
/**
 * Fetch function for searching highway alerts by route, region, time range, and milepost
 */
export declare const searchAlerts: (params?: FetchFunctionParams<SearchAlertsInput>) => Promise<Alert[]>;
/**
 * React Query hook for searching highway alerts by route, region, time range, and milepost
 */
export declare const useSearchAlerts: (params?: FetchFunctionParams<SearchAlertsInput>, options?: QueryHookOptions<Alert[]>) => UseQueryResult<Alert[], Error>;
//# sourceMappingURL=searchAlerts.d.ts.map