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.46 kB
TypeScript
import type { UseQueryResult } from "@tanstack/react-query";
import type { FetchFunctionParams, QueryHookOptions } from "../../types";
import { type WeatherInformationByStationIdInput } from "./shared/weatherInfo.input";
import { type WeatherInfo } from "./shared/weatherInfo.output";
/**
* Metadata for the fetchWeatherInformationByStationId endpoint
*/
export declare const weatherInformationByStationIdMeta: {
functionName: string;
endpoint: string;
inputSchema: import("zod").ZodObject<{
StationID: import("zod").ZodInt;
}, import("zod/v4/core").$strip>;
outputSchema: import("zod").ZodObject<{
BarometricPressure: import("zod").ZodNullable<import("zod").ZodNumber>;
Latitude: import("zod").ZodNumber;
Longitude: import("zod").ZodNumber;
PrecipitationInInches: import("zod").ZodNullable<import("zod").ZodNumber>;
ReadingTime: import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<Date, string>>;
RelativeHumidity: import("zod").ZodNullable<import("zod").ZodNumber>;
SkyCoverage: import("zod").ZodNullable<import("zod").ZodString>;
StationID: import("zod").ZodInt;
StationName: import("zod").ZodNullable<import("zod").ZodString>;
TemperatureInFahrenheit: import("zod").ZodNullable<import("zod").ZodNumber>;
Visibility: import("zod").ZodNullable<import("zod").ZodInt>;
WindDirection: import("zod").ZodNullable<import("zod").ZodNumber>;
WindDirectionCardinal: import("zod").ZodNullable<import("zod").ZodString>;
WindGustSpeedInMPH: import("zod").ZodNullable<import("zod").ZodNumber>;
WindSpeedInMPH: import("zod").ZodNullable<import("zod").ZodNumber>;
}, import("zod/v4/core").$strip>;
sampleParams: {
StationID: number;
};
endpointDescription: string;
};
/**
* Fetch function for retrieving current weather information for a specific station by ID
*/
export declare const fetchWeatherInformationByStationId: (params?: FetchFunctionParams<WeatherInformationByStationIdInput>) => Promise<WeatherInfo>;
/**
* React Query hook for retrieving current weather information for a specific station by ID
*/
export declare const useWeatherInformationByStationId: (params?: FetchFunctionParams<WeatherInformationByStationIdInput>, options?: QueryHookOptions<WeatherInfo>) => UseQueryResult<WeatherInfo, Error>;
//# sourceMappingURL=weatherInformationByStationId.d.ts.map