https://github.com/devorein/weyder-package
A basic weather package that utilizes darksky and mapbox api ...
https://github.com/devorein/weyder-package
forecast weather-api weather-data weather-information
Last synced: 5 months ago
JSON representation
A basic weather package that utilizes darksky and mapbox api ...
- Host: GitHub
- URL: https://github.com/devorein/weyder-package
- Owner: Devorein
- Created: 2019-08-02T13:47:01.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-08-10T10:00:11.000Z (about 6 years ago)
- Last Synced: 2025-05-07T14:05:24.640Z (5 months ago)
- Topics: forecast, weather-api, weather-data, weather-information
- Language: JavaScript
- Homepage:
- Size: 249 KB
- Stars: 9
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
## Weyder
### 1. Installation
```cmd
npm install weyder
```
### 2. Using weyder
```js
const weyder = require('weyder') // OR
const {geoCode,foreCast,setAccessToken,setWeatherDataSpan} = require('weyder');
```
#### Exported values overview
- `geoCode` (location) => [ latitude,longitude ]
- `foreCast` ([ latitude,longitude ]) => weather Information
- `setAccessToken` ("mapbox" || "darksky", mapbox_token || darksky_token)
- `setWeatherDataSpan` ({"currently" || "minutely" || "daily": `boolean`})
#### `setAccessToken`
This function is used to set the access token of mapbox and darksky endpoints
**Create a free darksky and mapbox account, copy your own access token and pass the api name and access token to `setAccessToken`**
```js
setAccessToken("darksky","your_DarkSky_AccessToken")
setAccessToken("mapbox","your_MapBox_AccessToken")
```
#### `setWeatherDataSpan`
Use this function and set appropriate time span to get the more information from the api.
Object properties `currently, minutely, hourly, daily`, value ``
```js
setWeatherDataSpan({
'currently': true,
'minutely': false,
'daily': true
})
```
The above sets
- `currently = true`,
- `minutely = false`,
- `hourly = false`,
- `daily = true`
---
### 3. Necessary Resources
NOTE: To undestand what `currently, hourly, daily` holds, visit https://darksky.net/dev/docs#data-point
#### Here's a snapshot of `currently`
#### Here's a snapshot of `hourly`
#### Here's a snapshot of `daily`
### 4. Basic Usage
#### Using the api (async/await style)
```js
const getWeatherData = async (location) =>{
const geocode = await geoCode(location)
const forecast = await foreCast(geocode)
console.log(forecast)
}
getWeatherData("Austin")
// Output
// {
// currently: [...],
// hourly: [...]
// daily: [...],
// }
```
#### Using the api (promises style)
```js
geoCode('Austin')
.then(geocode => foreCast(geocode))
.then(forecast => {
console.log(forecast);
})
.catch(e=>{
console.log(e);
})
// Output
// {
// currently: [...],
// hourly: [...]
// daily: [...],
// }
```
#### Using the api (callbacks style)
```js
geoCode("Austin",(err,geocode)=>{
if(err) return err
foreCast(geocode,(err,forecast)=>{
if(err) return err
console.log(forecast)
})
})
// Output
// {
// currently: [...],
// hourly: [...]
// daily: [...],
// }
```
### 5. Total Usage
```js
const {geoCode,foreCast,setAccessToken,setWeatherDataSpan} = require('weyder');
setAccessToken("darksky","your_DarkSky_AccessToken")
setAccessToken("mapbox","your_MapBox_AccessToken")
setWeatherDataSpan({
'currently': true,
'minutely': false,
'daily': true
})
geoCode('Austin')
.then(geocode => foreCast(geocode))
.then(forecast => {
console.log(forecast);
})
.catch(e=>{
console.log(e);
})
// Output
// {
// currently: [...],
// hourly: [...]
// daily: [...],
// }
```
**TODO**:
--
1. Still thinking :^)