weather-emoji
weather-emoji is a tiny module who return the weather of the area you enter and return an emoji who represent the temperature situation.
Content
🐙
Install Install NodeJs and run
npm install -D weather-emoji
Then import the package.
import WeatherEmoji from "weather-emoji"
Note - We're using the openweather API to fetch the data, it requires that you create a key, click on the link to register and generate your key.
🖍
Exemples import WeatherEmoji from "weather-emoji";
const weatherEmoji = new WeatherEmoji(secretApiKey);
const emojiParis = weatherEmoji.getWeather("paris", true).then(data => data);
console.log(emojiParis.emoji); // return emoji
Example with async/await
.
import WeatherEmoji from "weather-emoji";
(async () => {
const weatherEmoji = new WeatherEmoji(secretApiKey);
const emojiNewYork = await weatherEmoji.getWeather("new york", true);
console.log(emojiNewYork.emoji);
})()
👩💻
API new WeatherEmoji(apiKey)
The WeatherEmoji class provide methods and properties who return emoji and data representing the climatic situation of a city.
-
apiKey
{string} - Your api key generate by openweather api.
Return an object with methods and properties below:
_apiKey
- Return
string
- Your API key it is recommended to hide this data to the client.
_apiUrl
- Return
string
- The url we're using to fetch the data.
getWeather(cityName, celsius)
This method fetch data about a city and return data and emoji about this city.
-
cityName
{string} - The city name to retrieve data. -
celsius
{boolean} default true - If false the temperature will be in farenheit.
Return a Promise which resolve if the cityName
argument is correct.
-
code
{number} Result status code. -
emoji
{string} The emoji. -
temperature
{object} Object with data about temperature.-
actual
{float} Actual temperature. -
max
{float} Maximum temperature. -
min
{float} Minimum temperature.
-
🍰
Contributing Please make sure to read the Contributing Guide before making a pull request.
Thank you to all the people who already contributed to this project!
👷
Maintainers List of maintainers, replace all href
, src
attributes by your maintainers datas.
Tostee Lucas |
⚖️
License MIT