Class CurrentConditionAPI

Current condition API Playground: https://developer.accuweather.com/accuweather-current-conditions-api/apis

Hierarchy

APIClientBase
- CurrentConditionAPI

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CurrentConditionAPI(options: Omit<IInitOptions, "metric" | "offset">): CurrentConditionAPI

Overrides APIClientBase.constructor
- Defined in API/CurrentConditionAPIClient.ts:23
Initialize the client

Parameters
- options: Omit<IInitOptions, "metric" | "offset">
  
  Init options
Returns CurrentConditionAPI

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

Methods

HistoricalCurrentConditions

HistoricalCurrentConditions(hour: 24 | 6, locationKey: string): Promise<ICurrentConditionData[]>

- Defined in API/CurrentConditionAPIClient.ts:61
Parameters
- hour: 24 | 6
- locationKey: string
Returns Promise<ICurrentConditionData[]>

currentCondition

currentCondition(locationKey: string): Promise<ICurrentConditionData[]>

- Defined in API/CurrentConditionAPIClient.ts:35
Parameters
- locationKey: string
Returns Promise<ICurrentConditionData[]>

Protected handleError

handleError(error: AxiosError<any>): AccuWeatherAPIError

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

topCitiesCurrentCondition

topCitiesCurrentCondition(group: 50 | 100 | 150): Promise<ITopCitiesCurrentConditionData[]>

- Defined in API/CurrentConditionAPIClient.ts:47
Parameters
- group: 50 | 100 | 150
Returns Promise<ITopCitiesCurrentConditionData[]>

Generated using TypeDoc