Class OpenUVClient

Client that will passthrough to function with original API Key. Just to avoid passing around the API key. If you're going to use a single function, I would just recommend using the functions.

Hierarchy

OpenUVClient

Index

Constructors

Methods

getDailyProtectionTime getForecast getRealTimeUV

Constructors

constructor

new OpenUVClient(apiKey: string): OpenUVClient
Parameters
- apiKey: string
Returns OpenUVClient
- Defined in openuv.ts:48

Methods

getDailyProtectionTime

getDailyProtectionTime(options?: DailyProtectionTimeParams): Promise<DailyProtectionTimeResponse>
Get protection time by location, UV "from" and UV "to" values with 10 minutes accuracy. Optional altitude and ozone level could be provided.
Parameters
- Optional options: DailyProtectionTimeParams
  
  Your API key from OpenUV.io
Returns Promise<DailyProtectionTimeResponse>
- Defined in openuv.ts:58

getForecast

getForecast(options?: OpenUVParams): Promise<ForecastResponse>
Get hourly UV Index Forecast by location and date. Optional altitude, ozone level and datetime could be provided.
Parameters
- Optional options: OpenUVParams
  
  Your API key from OpenUV.io
Returns Promise<ForecastResponse>
- Defined in openuv.ts:54

getRealTimeUV

getRealTimeUV(options?: OpenUVParams): Promise<RealTimeUVResponse>
Get real-time UV Index by location. Optional altitude, ozone level and datetime could be provided as query parameters.
Parameters
- Optional options: OpenUVParams
  
  API key from OpenUV.io
Returns Promise<RealTimeUVResponse>
- Defined in openuv.ts:50

Generated using TypeDoc