npm-openweathermap

0.0.1 • Public • Published

npm-openweathermap NPM version Build Status Dependency Status

Generate a weather forecast using http://www.openweathermap.com/ API.

Installation

$ npm install --save npm-openweathermap

Usage

var weather = require('npm-openweathermap');
 
// api_key is required. You can get one at http://www.openweathermap.com/
weather.api_key = 'YOUR-API-KEY';
 
// OPTIONAL: you can set return temperature unit.
// 'k' for Kelvin
// 'c' for Celsius
// 'f' for Fahrenheit
weather.temp = 'c';

Basic usage

weather.current_weather()
.then(function(result){
    console.log(result);
},function(error){
    console.log(error);
});
 
weather.forecast_weather()
.then(function(result){
    console.log(result);
},function(error){
    console.log(error);
})

Custom weather queries

This package allows custom queries to Openweathermap throw get_weather_custom function.

// @function get_weather_custom(param_type, params, type)
// @params:
// param_type: 
// One of three values:
// 'city': query by city name
// 'zip': query by zipcode
// 'coordinates': query by coordinates
// params:
// City name or zipcode or coordinates object
// type:
// One of two values:
// 'weather': query for current weather
// 'forecast': query for forecast
 
weather.get_weather_custom('city', 'London', 'forecast').then(function(res){
    console.log(res);
},function(error){
    console.log(error)
})
 
weather.get_weather_custom('zip', '21804', 'weather').then(function(res){
    console.log(res);
},function(error){
    console.log(error)
})
 
var location = {
    longitude: '138.933334',
    latitude: '34.966671',
}
weather.get_weather_custom('coordinates', location, 'weather').then(function(res){
    console.log(res);
},function(error){
    console.log(error)
})

License

MIT © NghiaTran

Package Sidebar

Install

npm i npm-openweathermap

Weekly Downloads

3

Version

0.0.1

License

MIT

Last publish

Collaborators

  • nghiattran