ws-dottie
Version:
Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration
27 lines • 1.27 kB
TypeScript
import type { UseQueryResult } from "@tanstack/react-query";
import type { FetchFunctionParams, QueryHookOptions } from "../../types";
import { type MapAreasInput } from "./shared/alertAreas.input";
import { type Area } from "./shared/alertAreas.output";
/**
* Metadata for the fetchMapAreas endpoint
*/
export declare const mapAreasMeta: {
functionName: string;
endpoint: string;
inputSchema: import("zod").ZodObject<{}, import("zod/v4/core").$strip>;
outputSchema: import("zod").ZodArray<import("zod").ZodObject<{
MapArea: import("zod").ZodNullable<import("zod").ZodString>;
MapAreaDescription: import("zod").ZodNullable<import("zod").ZodString>;
}, import("zod/v4/core").$strip>>;
sampleParams: {};
endpointDescription: string;
};
/**
* Fetch function for retrieving all available geographic map areas for filtering alerts
*/
export declare const fetchMapAreas: (params?: FetchFunctionParams<MapAreasInput>) => Promise<Area[]>;
/**
* React Query hook for retrieving all available geographic map areas for filtering alerts
*/
export declare const useMapAreas: (params?: FetchFunctionParams<MapAreasInput>, options?: QueryHookOptions<Area[]>) => UseQueryResult<Area[], Error>;
//# sourceMappingURL=mapAreas.d.ts.map