on

openweathermap-node

An Openweathermap wrapper for nodejs

Showing:

Popularity

Downloads/wk

115

GitHub Stars

10

Maintenance

Last Commit

2mos ago

Contributors

2

Package

Dependencies

1

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

OpenWeatherMap-Node

An Openweathermap wrapper for nodejs

You need an API Key to use the OpenWeatherMap API. Head on over to their website if you don't already have one.

Installation

npm install openweathermap-node

Usage

Instantiate the OpenWeatherMapHelper class

const OpenWeatherMapHelper = require("openweathermap-node");

Set your API Key (Required)

const helper = new OpenWeatherMapHelper(
    {
        APPID: 'YOUR_OPENWEATHERMAP_API_KEY_GOES_HERE',
        units: "imperial",
        lang: "en"
    }
);
Unit Options(Optional, Kelvin by default) :
  1. imperial

  2. metric

Language Options(Optional, English by default) :
CodeLanguage
afAfrikaans
alAlbanian
arArabic
azAzerbaijani
bgBulgarian
caCatalan
czCzech
daDanish
deGerman
elGreek
enEnglish
euBasque
faPersian (Farsi)
fiFinnish
frFrench
glGalician
heHebrew
hiHindi
hrCroatian
huHungarian
idIndonesian
itItalian
jaJapanese
krKorean
laLatvian
ltLithuanian
mkMacedonian
noNorwegian
nlDutch
plPolish
ptPortuguese
pt_brPortuguês Brasil
roRomanian
ruRussian
sv, seSwedish
skSlovak
slSlovenian
sp, esSpanish
srSerbian
thThai
trTurkish
ua, ukUkrainian
viVietnamese
zh_cnChinese Simplified
zh_twChinese Traditional
zuZulu

Features

(1) Current Weather

Get current weather by City Name:

helper.getCurrentWeatherByCityName("Accra", (err, currentWeather) => {
    if(err){
        console.log(err);
    }
    else{
        console.log(currentWeather);
    }
});

Get current weather by City ID:

helper.getCurrentWeatherByCityID("524901", (err, currentWeather) => {
    if(err){
        console.log(err);
    }
    else{
        console.log(currentWeather);
    }
});

Get current weather by Geographic Coordinates:

helper.getCurrentWeatherByGeoCoordinates(5.6037, 0.1870, (err, currentWeather) => {
    if(err){
        console.log(err);
    }
    else{
        console.log(currentWeather);
    }
});

Get current weather by Zip Code:

helper.getCurrentWeatherByZipCode("90003", (err, currentWeather) => {
    if(err){
        console.log(err);
    }
    else{
        console.log(currentWeather);
    }
});

(2) 5 day / 3 hour forecast

Get three hour forecast by City Name:

helper.getThreeHourForecastByCityName("Pretoria", (err, threeHourForecast) => {
    if(err){
        console.log(err);
    }
    else{
        console.log(threeHourForecast);
    }
});

Get three hour forecast by City ID:

helper.getThreeHourForecastByCityID("524901", (err, threeHourForecast) => {
    if(err){
        console.log(err);
    }
    else{
        console.log(threeHourForecast);
    }
});

Get three hour forecast by Geographic Coordinates:

helper.getThreeHourForecastByGeoCoordinates(6.5244,3.3792, (err, threeHourForecast) => {
    if(err){
        console.log(err);
    }
    else{
        console.log(threeHourForecast);
    }
});

Get three hour forecast by Zip Code:

helper.getThreeHourForecastByZipCode("94040", (err, threeHourForecast) => {
    if(err){
        console.log(err);
    }
    else{
        console.log(threeHourForecast);
    }
});

Upcoming Feature

  1. 16 day / daily forecast

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial