Class ForecastAPI

Forecast API Playground: https://developer.accuweather.com/accuweather-forecast-api/apis

Hierarchy

APIClientBase
- ForecastAPI

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ForecastAPI(options: Omit<IInitOptions, "offset">): ForecastAPI

Overrides APIClientBase.constructor
- Defined in API/ForecastAPIClient.ts:27
Initialize the client

Parameters
- options: Omit<IInitOptions, "offset">
  
  Init options
Returns ForecastAPI

Properties

apikey

apikey: string

Accu Weather API key.

Private axiosInstance

axiosInstance: AxiosInstance

The instance that send requests to API

detail

detail: boolean

Whether return full object when searching

language

language: string

Language of retrieve data

metric

metric: boolean

Whether or not to return metric values.

Methods

getDailyForecast

getDailyForecast(day: 1 | 5 | 10 | 15, locationKey: string): Promise<IDailyForecastData>

- Defined in API/ForecastAPIClient.ts:47
Get daily forecast data for a specific location.

Parameters
- day: 1 | 5 | 10 | 15
  
  days of forecast to return
- locationKey: string
  
  Location key
Returns Promise<IDailyForecastData>

Daily Forecast data

getHourlyForecast

getHourlyForecast(hours: 1 | 12 | 24 | 72 | 120, locationKey: string): Promise<IHourlyForecastData[]>

- Defined in API/ForecastAPIClient.ts:68
Get daily forecast data for a specific location.

Parameters
- hours: 1 | 12 | 24 | 72 | 120
  
  hours of forecast to return
- locationKey: string
  
  Location key
Returns Promise<IHourlyForecastData[]>

Hourly Forecast data

Protected handleError

handleError(error: AxiosError<any>): AccuWeatherAPIError

Inherited from APIClientBase.handleError
- Defined in API/APIClientBase.ts:25
Parameters
- error: AxiosError<any>
Returns AccuWeatherAPIError

Generated using TypeDoc