openweathermap-fetcher
Advanced tools
Comparing version 1.0.0 to 1.0.1
{ | ||
"name": "openweathermap-fetcher", | ||
"version": "1.0.0", | ||
"version": "1.0.1", | ||
"main": "dist/index.js", | ||
@@ -10,3 +10,10 @@ "types": "dist/types/index.d.ts", | ||
}, | ||
"keywords": ["openweathermap","node","api"], | ||
"repository": { | ||
"type": "git", | ||
"url": "https://github.com/SubramanyaKS/openweathermap-fetcher" | ||
}, | ||
"bugs": { | ||
"url": "https://github.com/SubramanyaKS/openweathermap-fetcher/issues" | ||
}, | ||
"keywords": ["openweathermap","node","api","weather"], | ||
"author": "SubramanyaKS", | ||
@@ -13,0 +20,0 @@ "license": "MIT", |
@@ -1,4 +0,13 @@ | ||
# Openweathermap-wrapper | ||
A wrapper for openweathermap api.Currently in initial stage. | ||
# Openweathermap-fetcher | ||
A fetcher for openweathermap api.Currently in initial stage. | ||
## Prerequisite | ||
To use this package API key of openweathermap is needed. To get this you need to | ||
1. Go to [openweathermap](https://openweathermap.org/) website. | ||
2. Create an free account. | ||
3. Login wto your account and get the API Key. | ||
currently tested on free account openweather API. | ||
## Installation | ||
@@ -9,3 +18,3 @@ | ||
```sh | ||
npm install openweathermap-wrapper | ||
npm install openweathermap-fetcher | ||
``` | ||
@@ -15,3 +24,3 @@ or | ||
```sh | ||
yarn add openweathermap-wrapper | ||
yarn add openweathermap-fetcher | ||
``` | ||
@@ -23,3 +32,3 @@ | ||
import { OpenWeatherMap } from 'openweathermap-wrapper'; | ||
import { OpenWeatherMap } from 'openweathermap-fetcher'; | ||
@@ -43,5 +52,13 @@ const apiKey='your_api_key'; | ||
## Method | ||
1. ```js fetchWeatherDataByCityName(cityName:string)``` | ||
The method will fetch the data by taking cityname as an argument and returns weather data. | ||
2. ```js fetchWeatherDataByCoordinates(latitude:string,longitude:string)``` | ||
This method will fetch the data by taking longitude and latitude as an argument and returns weather data. | ||
## Contribution | ||
We welcome contributions! If you'd like to contribute to openweathermap-wrapper, please follow our [Contribution Guidelines](https://github.com/SubramanyaKS/openweathermap-wrapper/blob/main/CONTRIBUTING.md). | ||
We welcome contributions! If you'd like to contribute to openweathermap-wrapper, please follow our [Contribution Guidelines](https://github.com/SubramanyaKS/openweathermap-fetcher/blob/main/CONTRIBUTING.md). | ||
@@ -48,0 +65,0 @@ ## Author |
No bug tracker
MaintenancePackage does not have a linked bug tracker in package.json.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
4310
0
68
0