@nbbj/stroll/dist/api/Weather.js

NodeJS computational library for finding the optimal walking path to be as exposed to nature as possible.

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.Weather = void 0;

var _suncalc = _interopRequireDefault(require("suncalc"));

function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

/*
MIT License

Copyright (c) 2019 Nate Holland, Petar Mitev, NBBJ

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/

/**
 * Module for getting weather-specific data from a place.
 */
class Weather {
  /**
   * Get a vector representation of the sun's position at the given location and today's date.
   * @param {Number} lat Latitude of location.
   * @param {Number} long Longitude of location.
   * @returns {Object} An object containing azimuth and sun angle properties.
   */
  static SunPositionToday(lat, long) {
    return _suncalc.default.getPosition(Date.now(), lat, long);
  }
  /**
   * Get a vector representation of the sun's position at the given location and date.
   * @param {Number} lat Latitude of location.
   * @param {Number} long Longitude of location.
   * @param {Date} date Date to compute location at.
   * @returns {Object} An object containing azimuth and sun angle properties.
   */


  static SunPosition(lat, long, date) {
    return _suncalc.default.getPosition(date, lat, long);
  }

}

exports.Weather = Weather;