Skip to content

Latest commit

 

History

History
132 lines (108 loc) · 2.74 KB

Readme.md

File metadata and controls

132 lines (108 loc) · 2.74 KB

Openweather-Node

Openweather-Node is for get weather from openweather api.

Installation

npm install -g openweather-node --save

Example

var weather = require("Openweather-Node")
	
weather.now("Lyon",function(err, aData)
{	
	if(err) console.log(err);
	else
	{
		console.log(aData.getKelvinTemp())
		console.log(aData.getDegreeTemp())
		console.log(aData.getFahrenheitTemp())
	}
})

/*
* { temp: 281.15, temp_min: 281.15, temp_max: 281.15 }
* { temp: 8, temp_min: 8, temp_max: 8 }
* { temp: 46.4, temp_min: 46.4, temp_max: 46.4 }
*/

How to use

Instantiate the module

var weather = require("Openweather-Node")

//set your API key if you have one
weather.setAPPID("Your API Key");
//set the culture
weather.setCulture("fr");
//set the forecast type
weather.setForecastType("daily"); //or "" for 3 hours forecast

Use the differents function

weather.now("Location",function(err, aData)
//Location can be id, city name (coordinates can only be used with an array of location see the next explaination)
{	
	if(err) console.log(err);
	else
	{
		//you can use weather 'object' aData
		
		/*Get the temperature in JSON object
		* {temp :  , temp_min : , temp_max :}
		*/
		
		weather.getKelvinTemp(); //In kelvin
		weather.getDegreeTemp(); //In Degree
		weather.getFahrenheitTemp(); //In Fahrenheit
		
		/*Get the icon url of the current weather*/
		weather.getIconUrl();
	}
})

//if you give an array of location you get an array of weathers, you can provide array of coordinates ([[lat,lon],[...]])
weather.now(["location1","location2"],function(err, datas)
//Location can be id, city name or coordinate ([lat,lon])
{
	if(err) console.log(err);
	else
	{
		datas.forEach(function(aData)
		{
			//same weather.now
		})
	}
})

weather.forecast("Location",function(err, aData)
//Location can be id, city name or coordinate ([lat,lon])
{	
	if(err) console.log(err);
	else
	{
		//you can use weather 'object' aData
	
		/*Get the temperature in JSON object
		*Here you have to send the position in the forecast
		* {temp :  , temp_min : , temp_max :}*/	
		
		weather.getKelvinTemp(0); //In kelvin
		weather.getDegreeTemp(0); //In Degree
		weather.getFahrenheitTemp(0); //In Fahrenheit
		
		/*Get the icon url of the current weather
		*Here you have to send the position in the forecast*/
		
		weather.getIconUrl(0);
	}
})

//if you give an array of location you get an array of weathers
weather.forecast(["location1","location2"],function(err, datas)
//Location can be id, city name or coordinate ([lat,lon])
{
	if(err) console.log(err);
	else
	{
		datas.forEach(function(aData)
		{
			//same weather.forecast
		})
	}
})

weather.find("Location",function(err, find)
{
	if(err) console.log(err);
	else
	{
		find.toCityArray()
	}
})