Class CurrentWeatherApi

A client of https://openweathermap.org/current#cities

Index

Constructors

Properties

Methods

getCurrentWeather getCurrentWeatherForArea getCurrentWeatherNearby buildBboxParams buildCircleParams buildParams buildQuery

Constructors

constructor

new CurrentWeatherApi(httpClient): CurrentWeatherApi
Parameters
- httpClient: AxiosInstance
Returns CurrentWeatherApi
- Defined in currentWeatherApi.ts:19

Properties

`Private` httpClient

httpClient: AxiosInstance

Methods

getCurrentWeather

getCurrentWeather(request): Promise<CityWeather>
Get the current weather for an area as described by the request
Parameters
- request: CurrentRequest
Returns Promise<CityWeather>
- Defined in currentWeatherApi.ts:94

getCurrentWeatherForArea

getCurrentWeatherForArea(req): Promise<MultiCityResponse>
Parameters
- req: CurrentBoundingRequest
Returns Promise<MultiCityResponse>
- Defined in currentWeatherApi.ts:106

getCurrentWeatherNearby

getCurrentWeatherNearby(req): Promise<MultiCityResponse>
Parameters
- req: CurrentNearbyRequest
Returns Promise<MultiCityResponse>
- Defined in currentWeatherApi.ts:118

`Static` `Private` buildBboxParams

buildBboxParams(request): unknown
Private
Parameters
- request: CurrentBoundingRequest
Returns unknown
- Defined in currentWeatherApi.ts:61

`Static` `Private` buildCircleParams

buildCircleParams(request): unknown
Private
Parameters
- request: CurrentNearbyRequest
Returns unknown
- Defined in currentWeatherApi.ts:81

`Static` `Private` buildParams

buildParams(currentRequest): unknown
Private
Parameters
- currentRequest: CurrentRequest
Returns unknown
- Defined in currentWeatherApi.ts:43

`Static` `Private` buildQuery

buildQuery(req): undefined | string
Private
Parameters
- req: CurrentRequest
Returns undefined | string
- Defined in currentWeatherApi.ts:29

Generated using TypeDoc