UNPKG

ws-dottie

Version:

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

112 lines (75 loc) 3.77 kB
# Current Weather | Column | Column | Column | | --- | --- | --- | | Classes | | | class | [WeatherInformation](class_weather_information.html) | | | | | class | [WeatherStations](class_weather_stations.html) | | | | | class | [TravelerAPI.Controller.ScanwebController](class_traveler_a_p_i_1_1_controller_1_1_scanweb_controller.html) | | | | | class | [WeatherReading](class_weather_reading.html) | | | | | class | [WeatherInfo](class_weather_info.html) | | | | | Column | Column | Column | | --- | --- | --- | | Functions | | | [WeatherInfo](class_weather_info.html)[] | [WeatherInformation.GetCurrentWeatherInformation](group___weather.html#ga1f9ea5269827801afa00c5d3dd164315) (string AccessCode) | | | | | [WeatherInfo](class_weather_info.html)[] | [WeatherInformation.SearchWeatherInformation](group___weather.html#gae899e8ae798e4609e8f0e3c1377e6207) (string AccessCode, int StationID, DateTime SearchStartTime, DateTime SearchEndTime) | | | | | [WeatherInfo](class_weather_info.html) | [WeatherInformation.GetCurrentWeatherInformationByStationID](group___weather.html#ga0c017472aa2114e24582bbece0779917) (string AccessCode, int StationID) | | | | | [WeatherInfo](class_weather_info.html)[] | [WeatherInformation.GetCurrentWeatherForStations](group___weather.html#gaec276278969f3e3eed6b3ffec3f00dbe) (string AccessCode, string StationList) | | | | ## Detailed Description Weather reports from WSDOT maintained weather stations ## Function Documentation ## [◆](#gaec276278969f3e3eed6b3ffec3f00dbe)GetCurrentWeatherForStations() | Column | Column | Column | Column | Column | | --- | --- | --- | --- | --- | | [WeatherInfo](class_weather_info.html)[] WeatherInformation.GetCurrentWeatherForStations | ( | string | *AccessCode*, | | | | string | *StationList* | | | ) | | | ## [◆](#ga1f9ea5269827801afa00c5d3dd164315)GetCurrentWeatherInformation() | Column | Column | Column | Column | Column | Column | Column | | --- | --- | --- | --- | --- | --- | --- | | [WeatherInfo](class_weather_info.html)[] WeatherInformation.GetCurrentWeatherInformation | ( | string | *AccessCode* | ) | | Returns the most recent reading from each weather station **Parameters:** | Parameter | Description | | --- | --- | | AccessCode | Your Traveler API Access Code. | **Returns:** [WeatherInfo](class_weather_info.html "Current information from a weather station.") array ## [◆](#ga0c017472aa2114e24582bbece0779917)GetCurrentWeatherInformationByStationID() | Column | Column | Column | Column | Column | | --- | --- | --- | --- | --- | | [WeatherInfo](class_weather_info.html) WeatherInformation.GetCurrentWeatherInformationByStationID | ( | string | *AccessCode*, | | | | int | *StationID* | | | ) | | | Gets the most recent weather report from the chosen station **Parameters:** | Parameter | Description | | --- | --- | | AccessCode | Your Traveler API Access Code.kokkkikilsdkjfasdflkj | | StationID | | Returns ## [◆](#gae899e8ae798e4609e8f0e3c1377e6207)SearchWeatherInformation() | Column | Column | Column | Column | Column | | --- | --- | --- | --- | --- | | [WeatherInfo](class_weather_info.html)[] WeatherInformation.SearchWeatherInformation | ( | string | *AccessCode*, | | | | int | *StationID*, | | | | DateTime | *SearchStartTime*, | | | | DateTime | *SearchEndTime* | | | ) | | | Returns all readings between the two given times for the chosen station, up to a week max. **Parameters:** | Parameter | Description | | --- | --- | | AccessCode | Your Traveler API Access Code. | | StationID | | | SearchStartTime | | | SearchEndTime | | Returns * Generated by [![doxygen](doxygen.svg)](https://www.doxygen.org/index.html) 1.9.5