location-weather-info

1.4.5 • Public • Published

Location Weather Info

Retrieve current weather information based on user's location.

NPM Version Install Size Total Downloads

Demo

Home Page: Location Weather Info

Features

Get user's current weather information based on:

  • Co-ordinates (Latitude & Longitude)
  • Location Name (Street/City/State/Country)

Installation

Using npm:

$ npm install location-weather-info

Using yarn:

$ yarn add location-weather-info

Example

Step-1: Import LocationWeatherInfo after installation.

import LocationWeatherInfo from 'location-weather-info'

Step-2: Declare the constructor and pass your API KEY. Your can get your API_KEY from Open Weather Map. You must login to get your secret key.

const weather = new LocationWeatherInfo(API_KEY);

Step-3: Now you can get the current weather info based on Co-ordinates (Latitude & Longitude) or Location Name.

//Get weather by Co-ordinates (latitude, longitude)
const weatherByCoords = weather.getWeatherByCoords(35, 139);
console.log(weatherByCoords);

//Get weather by Location Name
const weatherByLocationName = weather.getWeatherByLocation("Tokyo");
console.log(weatherByLocationName);

N.B: Both function returns promise, it might be needed to handle from client side.

Output

If you pass the required arguments then you will get the response with an object like:

{success: true, data: weatherData}

If any error is occurred then the response will be:

{success: false, error: errorMessage}

Browser Support

Chrome Firefox Safari Opera Edge IE
Latest Latest Latest Latest Latest 11

Caution

This open source project is beginner friendly and made only for learning purpose, where we used Open Weather Map v2.5 with free-tier API end points. That's why your secret API key may revealed as payload. So in case of production you may purchase and handle the API end points manually instead of using this package. Also you can follow their guidelines here.

Author

@SharifRahat

Package Sidebar

Install

npm i location-weather-info

Weekly Downloads

52

Version

1.4.5

License

ISC

Unpacked Size

4.97 kB

Total Files

3

Last publish

Collaborators

  • sharifmrahat