Interface OpenWeatherMapClient

Basic client definintion for interacting with the OpenWeatherMap OneCall API.

Hierarchy

OpenWeatherMapClient

Index

Properties

forecast timeMachine

Properties

forecast

forecast: (<R>(request: ForecastRequest, optionalParams?: RequestParams) => Promise<R>)

Type declaration

- <R>(request: ForecastRequest, optionalParams?: RequestParams): Promise<R>
- Make a Forecast request.
  
  See One Call API for more info.
  Type Parameters
  - R extends Forecast
  Parameters
  - request: ForecastRequest
    
    Required Forecast request parameters.
  - Optional optionalParams: RequestParams
    
    Optional query params to add to the request.
  Returns Promise<R>

timeMachine

timeMachine: (<R>(request: TimeMachineRequest, optionalParams?: RequestParams) => Promise<R>)

Type declaration

- <R>(request: TimeMachineRequest, optionalParams?: RequestParams): Promise<R>
- Type Parameters
  - R extends Forecast
  Parameters
  - request: TimeMachineRequest
  - Optional optionalParams: RequestParams
  Returns Promise<R>

Generated using TypeDoc