Class OpenWeatherAPI

Hierarchy

OpenWeatherAPI

Constructors

constructor

new OpenWeatherAPI(globalOptions?): OpenWeatherAPI
Constructor of the class. You can specify global options here

Returns
OpenWeatherAPI object
Parameters
- globalOptions: Options = {}
  
  object that defines global options
Returns OpenWeatherAPI
- Defined in index.ts:76

Properties

`Private` globalOptions

globalOptions: Options

Methods

`Private` createURL

createURL(options, path?, additionalParams?): string
Parameters
- options: Options
- path: string = ""
- additionalParams: Record<string, string> = {}
Returns string
- Defined in index.ts:639

`Private` evaluateLanguage

evaluateLanguage(lang): "id" | "hr" | "th" | "tr" | "af" | "al" | "ar" | "az" | "bg" | "ca" | "cz" | "da" | "de" | "el" | "en" | "eu" | "fa" | "fi" | "fr" | "gl" | "he" | "hi" | "hu" | "it" | "ja" | "kr" | "la" | "lt" | "mk" | "no" | "nl" | "pl" | "pt" | "pt_br" | "ro" | "ru" | "sv" | "se" | "sk" | "sl" | "sp" | "es" | "sr" | "ua" | "uk" | "vi" | "zh_cn" | "zh_tw" | "zu"
Parameters
- lang: unknown
Returns "id" | "hr" | "th" | "tr" | "af" | "al" | "ar" | "az" | "bg" | "ca" | "cz" | "da" | "de" | "el" | "en" | "eu" | "fa" | "fi" | "fr" | "gl" | "he" | "hi" | "hu" | "it" | "ja" | "kr" | "la" | "lt" | "mk" | "no" | "nl" | "pl" | "pt" | "pt_br" | "ro" | "ru" | "sv" | "se" | "sk" | "sl" | "sp" | "es" | "sr" | "ua" | "uk" | "vi" | "zh_cn" | "zh_tw" | "zu"
- Defined in index.ts:159

`Private` evaluateLocationByCoordinates

evaluateLocationByCoordinates(coords): Coordinates
Parameters
- coords: unknown
Returns Coordinates
- Defined in index.ts:243

`Private` evaluateLocationByName

evaluateLocationByName(name, key): Promise<{
lat: any;
lon: any;
}>
Parameters
- name: unknown
- key: string
Returns Promise<{
lat: any;
lon: any;
}>
- Defined in index.ts:209

`Private` evaluateLocationByZipCode

evaluateLocationByZipCode(zipCode, key): Promise<{
lat: any;
lon: any;
}>
Parameters
- zipCode: unknown
- key: string
Returns Promise<{
lat: any;
lon: any;
}>
- Defined in index.ts:276

`Private` evaluateUnits

evaluateUnits(units): "standard" | "metric" | "imperial"
Parameters
- units: unknown
Returns "standard" | "metric" | "imperial"
- Defined in index.ts:186

`Private` fetch

fetch(url): Promise<Resp>
Parameters
- url: string
Returns Promise<Resp>
- Defined in index.ts:663

getAlerts

getAlerts(options?): Promise<Alert[]>
Getter for alerts
Note: some agencies provide the alert’s description only in a local language.

Returns
alerts
Parameters
- options: Options = {}
  
  options used only for this call
Returns Promise<Alert[]>
- Defined in index.ts:474

getAllLocations

getAllLocations(query, options?): Promise<Location[]>
Getter for locations from query

Returns
all found locations
Parameters
- query: string
  
  query used to search the locations (q parameter here)
- options: Options = {}
  
  options used only for this call
Returns Promise<Location[]>
- Defined in index.ts:322

getCurrent

getCurrent(options?): Promise<CurrentWeather>
Getter for current weather

Returns
weather object of current weather
Parameters
- options: Options = {}
  
  options used only for this call
Returns Promise<CurrentWeather>
- Defined in index.ts:348

getCurrentAirPollution

getCurrentAirPollution(options?): Promise<AirPollution>
Getter for current data about air pollution

Returns
Air Pollution Object with data about current pollution
Parameters
- options: Options = {}
  
  options used only for this call
Returns Promise<AirPollution>
- Defined in index.ts:551

getDailyForecast

getDailyForecast(limit?, includeToday?, options?): Promise<DailyWeather[]>
Getter for daily weather

Returns
array of Weather objects, one for every next day (Empty if API returned no info about daily weather)
Parameters
- limit: number = Number.POSITIVE_INFINITY
  
  maximum length of returned array
- includeToday: boolean = false
  
  boolean indicating whether to include today's weather in returned array
- options: Options = {}
  
  options used only for this call
Returns Promise<DailyWeather[]>
- Defined in index.ts:438

getEverything

getEverything(options?): Promise<Everything>
Getter for every type of weather call and alerts

Returns
object that contains everything
Parameters
- options: Options = {}
  
  options used only for this call
Returns Promise<Everything>
- Defined in index.ts:494

getForecast

getForecast(limit?, options?): Promise<ForecastWeather[]>
Getter for forecasted weather

Returns
array of Weather objects, one for every 3 hours, up to 5 days
Parameters
- limit: number = Number.POSITIVE_INFINITY
  
  maximum length of returned array
- options: Options = {}
  
  options used only for this call
Returns Promise<ForecastWeather[]>
- Defined in index.ts:367

getForecastedAirPollution

getForecastedAirPollution(limit?, options?): Promise<AirPollution[]>
Getter for future data about air pollution

Returns
Array of Air Pollution Objects with data about future pollution
Parameters
- limit: number = Number.POSITIVE_INFINITY
  
  maximum length of returned array
- options: Options = {}
  
  options used only for this call
Returns Promise<AirPollution[]>
- Defined in index.ts:570

getHistory

getHistory(dt, options?): Promise<HistoricalWeather>
Getter for historical data about weather
Parameters
- dt: string | number | Date
  
  Date from the previous five days (Unix time, UTC time zone)
- options: Options = {}
  
  options used only for this call
Returns Promise<HistoricalWeather>
- Defined in index.ts:522

getHistoryAirPollution

getHistoryAirPollution(from, to, options?): Promise<AirPollution[]>
Getter for historical data about air pollution WARNING: Historical data is accessible from 27th November 2020

Returns
Array of Air Pollution Objects with data about historical pollution
Parameters
- from: string | number | Date
  
  Start date (unix time, UTC time zone)
- to: string | number | Date
  
  End date (unix time, UTC time zone)
- options: Options = {}
  
  options used only for this call
Returns Promise<AirPollution[]>
- Defined in index.ts:594

getHourlyForecast

getHourlyForecast(limit?, options?): Promise<HourlyWeather[]>
Getter for hourly weather

Returns
array of Weather objects, one for every next hour (Empty if API returned no info about hourly weather)
Parameters
- limit: number = Number.POSITIVE_INFINITY
  
  maximum length of returned array
- options: Options = {}
  
  options used only for this call
Returns Promise<HourlyWeather[]>
- Defined in index.ts:413

getKey

getKey(): undefined | string
Getter for global key

Returns
global API key

Returns undefined | string
- Defined in index.ts:137

getLanguage

getLanguage(): undefined | "id" | "hr" | "th" | "tr" | "af" | "al" | "ar" | "az" | "bg" | "ca" | "cz" | "da" | "de" | "el" | "en" | "eu" | "fa" | "fi" | "fr" | "gl" | "he" | "hi" | "hu" | "it" | "ja" | "kr" | "la" | "lt" | "mk" | "no" | "nl" | "pl" | "pt" | "pt_br" | "ro" | "ru" | "sv" | "se" | "sk" | "sl" | "sp" | "es" | "sr" | "ua" | "uk" | "vi" | "zh_cn" | "zh_tw" | "zu"
Getter for global language

Returns
global language

Returns undefined | "id" | "hr" | "th" | "tr" | "af" | "al" | "ar" | "az" | "bg" | "ca" | "cz" | "da" | "de" | "el" | "en" | "eu" | "fa" | "fi" | "fr" | "gl" | "he" | "hi" | "hu" | "it" | "ja" | "kr" | "la" | "lt" | "mk" | "no" | "nl" | "pl" | "pt" | "pt_br" | "ro" | "ru" | "sv" | "se" | "sk" | "sl" | "sp" | "es" | "sr" | "ua" | "uk" | "vi" | "zh_cn" | "zh_tw" | "zu"
- Defined in index.ts:155

getLocation

getLocation(options?): Promise<null | Location>
Getter for location

Returns
location or null for no location
Parameters
- options: Options = {}
  
  options used only for this call
Returns Promise<null | Location>
- Defined in index.ts:300

getMinutelyForecast

getMinutelyForecast(limit?, options?): Promise<MinutelyWeather[]>
Getter for minutely weather

Returns
array of Weather objects, one for every next minute (Empty if API returned no info about minutely weather)
Parameters
- limit: number = Number.POSITIVE_INFINITY
  
  maximum length of returned array
- options: Options = {}
  
  options used only for this call
Returns Promise<MinutelyWeather[]>
- Defined in index.ts:389

getToday

getToday(options?): Promise<DailyWeather>
Getter for today's weather

Returns
weather object of today's weather NOT the same as current!
Parameters
- options: Options = {}
  
  options used only for this call
Returns Promise<DailyWeather>
- Defined in index.ts:463

getUnits

getUnits(): undefined | "standard" | "metric" | "imperial"
Getter for global units

Returns
global units

Returns undefined | "standard" | "metric" | "imperial"
- Defined in index.ts:182

`Private` parseOptions

parseOptions(options): Promise<Options>
Parameters
- options: Options
Returns Promise<Options>
- Defined in index.ts:674

setKey

setKey(key): void
Sets global API key
Parameters
- key: string
  
  api key
Returns void
- Defined in index.ts:127

setLanguage

setLanguage(lang): void
Sets global language (Language must be listed here)
Parameters
- lang: "id" | "hr" | "th" | "tr" | "af" | "al" | "ar" | "az" | "bg" | "ca" | "cz" | "da" | "de" | "el" | "en" | "eu" | "fa" | "fi" | "fr" | "gl" | "he" | "hi" | "hu" | "it" | "ja" | "kr" | "la" | "lt" | "mk" | "no" | "nl" | "pl" | "pt" | "pt_br" | "ro" | "ru" | "sv" | "se" | "sk" | "sl" | "sp" | "es" | "sr" | "ua" | "uk" | "vi" | "zh_cn" | "zh_tw" | "zu"
  
  language
Returns void
- Defined in index.ts:146

setLocationByCoordinates

setLocationByCoordinates(lat, lon): void
Sets global location by provided coordinates
Parameters
- lat: number
  
  latitude of the location
- lon: number
  
  longitude of the location
Returns void
- Defined in index.ts:235

setLocationByName

setLocationByName(name): void
Sets global location by provided name
Parameters
- name: string
  
  name of the location (q parameter here)
Returns void
- Defined in index.ts:200

setLocationByZipCode

setLocationByZipCode(zipCode): void
Sets global location by provided zip/post code
Parameters
- zipCode: string
  
  zip/post code and country code divided by comma (zip parameter here)
Returns void
- Defined in index.ts:267

setUnits

setUnits(units): void
Sets global units
Parameters
- units: "standard" | "metric" | "imperial"
  
  units (Only standard, metric or imperial are supported)
Returns void
- Defined in index.ts:173

`Private` uncacheLocation

uncacheLocation(): Promise<void>
Returns Promise<void>
- Defined in index.ts:614

Class OpenWeatherAPI

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns

Parameters

globalOptions: Options = {}

Returns OpenWeatherAPI

Properties

Private globalOptions

Methods

Private createURL

Parameters

options: Options

path: string = ""

additionalParams: Record<string, string> = {}

Returns string

Private evaluateLanguage

Parameters

lang: unknown

Private evaluateLocationByCoordinates

Parameters

coords: unknown

Returns Coordinates

Private evaluateLocationByName

Parameters

name: unknown

key: string

Returns Promise<{ lat: any; lon: any; }>

Private evaluateLocationByZipCode

Parameters

zipCode: unknown

key: string

Returns Promise<{ lat: any; lon: any; }>

Private evaluateUnits

Parameters

units: unknown

Returns "standard" | "metric" | "imperial"

Private fetch

Parameters

url: string

Returns Promise<Resp>

getAlerts

Returns

Parameters

options: Options = {}

Returns Promise<Alert[]>

getAllLocations

Returns

Parameters

query: string

options: Options = {}

Returns Promise<Location[]>

getCurrent

Returns

Parameters

options: Options = {}

Returns Promise<CurrentWeather>

getCurrentAirPollution

Returns

Parameters

options: Options = {}

Returns Promise<AirPollution>

getDailyForecast

Returns

Parameters

limit: number = Number.POSITIVE_INFINITY

includeToday: boolean = false

options: Options = {}

Returns Promise<DailyWeather[]>

getEverything

Returns

Parameters

options: Options = {}

Returns Promise<Everything>

getForecast

`Private` globalOptions

`Private` createURL

`Private` evaluateLanguage

`Private` evaluateLocationByCoordinates

`Private` evaluateLocationByName

Returns Promise<{
lat: any;
lon: any;
}>

`Private` evaluateLocationByZipCode

Returns Promise<{
lat: any;
lon: any;
}>

`Private` evaluateUnits

`Private` fetch

`Private` parseOptions