openweather-api-node
Advanced tools
Readme
Simple Node.js package that makes it easy to work with OpenWeather API. If you want to learn how to use this package check out examples in examples folder. The only thing that you need to get started is API key if you don't have one go to OpenWeatherMap website and get it. For now this package supports only some weather calls but we are planning on adding more features like: historical data, maps and all the other stuff that is available for free in OpenWeatherMap API.
const OpenWeatherAPI = require("openweathermap-api")
let weather = new OpenWeatherAPI({
key: "put-key-here",
locationName: "New York",
units: "imperial"
})
/*
you can use setters as well:
weather.setKey("put-key-here")
weather.setLocationByName("New York")
...
*/
weather.getCurrent().then(data => {
console.log(`Current temperature in New York is: ${data.weather.temp.cur}\u00B0F`)
})
Description:
Getter for global options
Returns:
Global options - Object
Example:
let options = weather.getGlobalOptions()
See also: options
Description:
Sets global API key
Arguments:
Example:
weather.setKey("key")
See also: options
Description:
Getter for global key
Returns:
Global API key - String
Example:
let key = weather.getKey()
See also: options
Description:
Sets global language (Language must be listed here)
Arguments:
Example:
weather.setLanguage("en")
See also: options
Description:
Getter for global language
Returns:
Global language - String
Example:
let language = weather.getLanguage()
See also: options
Description:
Sets global units
Arguments:
Example:
weather.setUnits("imperial")
See also: options
Description:
Getter for global units
Returns:
Global units - String
Example:
let units = weather.getUnits()
See also: options
Description:
Sets global location by provided name
Arguments:
Example:
weather.setLocationByName("London")
See also: options
Description:
Sets global location by provided coordinates
Arguments:
Example:
weather.setLocationByCoordinates(40.71, -74)
See also: options
async getLocation(options = {})Description:
Getter for location
Arguments:
Returns:
location - Object
Example:
let location = await weather.getLocation()
// or with options
location = await weather.getLocation({locationName: "Tokio"})
See also: options
async getCurrent(options = {})Description:
Getter for current weather
Arguments:
Returns:
Weather object of current weather - Object
Example:
let current = await weather.getCurrent()
// or with options
current = await weather.getCurrent({units: "metric"})
See also: options
async getMinutelyForecast(limit = Number.POSITIVE_INFINITY, options = {})Description:
Getter for minutely weather
Arguments:
Returns:
Array of Weather objects, one for every next minute (Empty if API returned no info about minutely weather) - Array
Example:
let minutely = await weather.getMinutelyForecast()
// or with limit
minutely = await weather.getMinutelyForecast(10)
// here minutely.length won't be larger than 10
See also: options
async getHourlyForecast(limit = Number.POSITIVE_INFINITY, options = {})Description:
Getter for hourly weather
Arguments:
Returns:
Array of Weather objects, one for every next hour (Empty if API returned no info about hourly weather) - Array
Example:
let hourly = await weather.getMinutelyForecast()
// or with limit
hourly = await weather.getMinutelyForecast(5)
// here hourly.length won't be larger than 5
See also: options
async getDailyForecast(limit = Number.POSITIVE_INFINITY, includeToday = false, options = {})Description:
Getter for daily weather
Arguments:
Returns:
Array of Weather objects, one for every next day (Empty if API returned no info about daily weather) - Array
Example:
let daily = await weather.getDailyForecast()
// or with limit
daily = await weather.getDailyForecast(3)
// here daily.length won't be larger than 3
See also: options
async getToday(options = {})Description:
Getter for today's weather. Equivalent to:
let today = (await weather.getDailyForecast(1, true, options))[0]
Not the same as current weather. getCurrent() returns current weather and this method returns summary of the whole present day.
Arguments:
Returns:
Weather object of today's weather - Object
Example:
let today = await weather.getToday()
// or with options
daily = await weather.getDailyForecast({coordinates:{
lat: -33.84,
lon: 151.18
}})
See also: options
async getAlerts(options = {})Description:
Getter for alerts
Arguments:
Returns:
Alerts (undefined if API returned no info about alerts) - Object
Example:
let alerts = await weather.getAlerts()
See also: options
async getEverything(options = {})Description:
Getter for every type of weather call and alerts
Arguments:
Returns:
Object that looks like this:
{
lat: latitude of the location,
lon: longitude of the location,
timezone: timezone of the location,
timezone_offset: timezone offset of the location,
current: current weather object,
minutely: array of minutely weather objects,
hourly: array of hourly weather objects,
daily: array of daily weather objects,
alerts: alerts
}
Example:
let everything = await weather.getEverything()
let current = everything.current
let minutely = everything.minutely
// and so on...
See also: options
Description:
Merges weather objects. Useful if for example you want to get minutely weather object but with more data than only rain volume, in this case you can merge minutely weather object with current weather object and get full weather object with data in nth minutes.
Arguments:
Returns:
Merged object of weather provided in weathers parameter - Object
Example:
let current = await weather.getCurrent()
let minutely = await weather.getMinutelyForecast()
let full = await weather.mergeWeathers([minutely[20], current])
See also:
This package use so called options, options define: API key, coordinates, units etc.
In the constructor of the class you can pass object that will define global options, they will be used by default in any method that uses options (ex. weather calls).
Some methods have options argument which can be used to specify options only for this call. Options specified in options argument will override global options. for example if your global options look like this:
{
key: "xyz",
locationName: "Moscow"
} // global options
and you pass options that look like this:
{
locationName: "Chicago"
} // options passed to `options` argument
actual used options will look like this:
{
key: "xyz",
locationName: "Chicago"
} // actual used options
because every option specified in options argument will override the corresponding global option.
When using raw API the problem might be getting your head around how unorganised the responses might be. This package simplifies this and makes every returned object the same structure. Every weather object will look like this:
// property: "Description" - type
{
lat: "Geographical coordinates of the location (latitude) " - Number,
lon: "Geographical coordinates of the location (longitude)" - Number,
dt: "Current time, Unix, UTC or Time of the forecasted data, Unix, UTC" - Date,
timezone: "Timezone name for the requested location" - String,
timezone_offset: "Shift in seconds from UTC" - Number,
astronomical: {
sunrise: "Sunrise time, Unix, UTC" - Date,
sunset: "Sunset time, Unix, UTC" - Date,
moonrise: "The time of when the moon rises for this day, Unix, UTC" - Date,
moonset: "The time of when the moon sets for this day, Unix, UTC" - Date,
moon_phase: "Moon phase. 0 and 1 are 'new moon', 0.25 is 'first quarter moon', 0.5 is 'full moon' and 0.75 is 'last quarter moon'. The periods in between are called 'waxing crescent', 'waxing gibous', 'waning gibous', and 'waning crescent', respectively." - Number
},
weather: {
temp: { // Actual temperature. Units – default: kelvin, metric: Celsius, imperial: Fahrenheit.
cur: "Current temperature or estimated temperature (in hourly forecast)" - Number,
morn: "Morning temperature." - Number,
day: "Day temperature." - Number,
eve: "Evening temperature." - Number,
night: "Night temperature." - Number,
min: "Lowest daily temperature." - Number,
max: "Highest daily temperature." - Number
},
feels_like: { // This accounts for the human perception of weather. Units – default: kelvin, metric: Celsius, imperial: Fahrenheit.
cur: "Current temperature or estimated temperature (in hourly forecast)." - Number,
morn: "Morning temperature." - Number,
day: "Day temperature." - Number,
eve: "Evening temperature." - Number,
night: "Night temperature." - Number
},
pressure: "Atmospheric pressure on the sea level, hPa" - Number,
humidity: "Humidity, %" - Number,
dew_point: "Atmospheric temperature (varying according to pressure and humidity) below which water droplets begin to condense and dew can form. Units – default: kelvin, metric: Celsius, imperial: Fahrenheit." - Number,
clouds: "Cloudiness, %" - Number,
uvi: "The maximum value of UV index for the day" - Number,
visibility: "Average visibility, metres" - Number,
wind: { // Wind statistics. Units – default: metre/sec, metric: metre/sec, imperial: miles/hour.
speed: "Wind speed." - Number,
gust: "Wind gust." - Number,
deg: "Wind direction, degrees (meteorological)" - Number
},
pop: "Probability of precipitation" - Number,
rain: "Precipitation volume, mm" - Number,
snow: "Snow volume, mm" - Number,
condition_id: "Weather condition id (https://openweathermap.org/weather-conditions#Weather-Condition-Codes-2)" - Number,
main: "Group of weather parameters (Rain, Snow, Extreme etc.)" - String,
description: "Description of the weather" - String,
icon: {
url: "Weather icon url." - String,
raw: "Weather icon id." - String
}
}
}
API does not specify every value in every call so some of those values might be undefined for example daily weather object wont have weather.temp.cur!
FAQs
Unknown package
We found that openweather-api-node demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.
Security News
The JavaScript community has launched the e18e initiative to improve ecosystem performance by cleaning up dependency trees, speeding up critical parts of the ecosystem, and documenting lighter alternatives to established tools.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.