Skip to content

use v3 Daily Forecast API #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
johnwalicki merged 1 commit into from
Sep 19, 2022
Merged

use v3 Daily Forecast API #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 18 additions & 15 deletions lib/daily-forecast.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,45 +1,48 @@
/**
* Daily Forecast
*
* - https://weather.com/swagger-docs/ui/sun/v1/sunV1DailyForecast.json
* - https://ibm.co/V3DFap
*
* The daily forecast API returns the geocode weather forecasts for the current day
* up to the days duration in the API endpoint. The daily forecast product can contain
* multiple days of daily forecasts for each location. Each day of a forecast can
* contain up to (3) “temporal segments” meaning three separate forecasts. For any
* given forecast day we offer day, night, and a 24-hour forecast (daily summary).
*
* Base URL: api.weather.com/v1
* Endpoint: /geocode/{latitude}/{longitude}/forecast/daily/{days}day.json
* Base URL: api.weather.com/v3
* Endpoint: /wx/forecast/daily/15day
*/

const apiUtil = require('./api-util')

exports.requestOptions = function (lat, lon, days = 3, units = 'm') {
const d = [3, 5, 7, 10, 15].indexOf(days) === -1 ? 3 : days
exports.requestOptions = function (lat, lon, days = 15, units = 'm') {
const d = [3, 5, 7, 10, 15].indexOf(days) === -1 ? 15 : days
const u = ['e', 'm', 'h', 's'].indexOf(units) === -1 ? 'm' : units

let options = apiUtil.defaultParams()

options['uri'] = `${apiUtil.HOST}/v1/geocode/${lat}/${lon}/forecast/daily/${d}day.json`
options.qs['units'] = u
let urlparams="&format=json&units="+options.qs['units']+"&language="+options.qs['language']+"&apiKey="+options.qs['apiKey']
options['url'] = `${apiUtil.HOST}/v3/wx/forecast/daily/${d}day?geocode=${lat},${lon}`+urlparams
//console.log( options );

return options
}

exports.handleResponse = function (res) {
if (res && res.hasOwnProperty('forecasts')) {
const forecasts = res.forecasts
console.log(`daily-forecast: returned ${forecasts.length}-day forecast`)
if (res && res.hasOwnProperty('narrative')) {
const forecasts = res
console.log(`daily-forecast: returned ${forecasts.dayOfWeek.length}-day forecast`)

// each entry in the forecasts array corresponds to a daily forecast
forecasts.forEach(daily => {
console.log(`daily-forecast: day ${daily.num} - High of ${daily['max_temp']}, Low of ${daily['min_temp']}`)
console.log(`daily-forecast: day ${daily.num} - ${daily.narrative}`)
})
// Parse responses
for( num=0; num<forecasts.dayOfWeek.length;num++) {
console.log("");
console.log(`daily-forecast: ${forecasts.dayOfWeek[num]} - High of ${forecasts.calendarDayTemperatureMax[num]}, Low of ${forecasts.calendarDayTemperatureMin[num]}`)
console.log(`daily-forecast: ${forecasts.dayOfWeek[num]} - ${forecasts.narrative[num]}`)
}

// additional entries include (but not limited to):
// lunar_phase, sunrise, day['uv_index'], night.wdir, etc
// moonPhase, sunrise, uvIndex, windDirection, etc
} else {
console.log('daily-forecast: no daily forecast returned')
}
Expand Down