Skip to content

Commit bd73c8e

Browse files
Add jsdoc to getRiseAndSetAtSolarAngle
1 parent f400527 commit bd73c8e

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

suncalc.js

+10
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,16 @@ SunCalc.getTimes = function (date, lat, lng, height) {
180180
return result;
181181
};
182182

183+
/**
184+
* Get the time at which the sun will have a given apparent angle when rising and when setting.
185+
*
186+
* @param {Date} date The date to get the times for. Only the date part is important.
187+
* @param {number} angle The angle of the sun relative to the Earth's horizon.
188+
* @param {number} lat The latitude.
189+
* @param {number} lng The longitude.
190+
* @param {number} [elevation=0] The elevation of the observer in meters.
191+
* @return {{set: Date, rise: Date}}
192+
*/
183193
SunCalc.getRiseAndSetAtSolarAngle = function (date, angle, lat, lng, elevation) {
184194

185195
elevation = elevation || 0;

0 commit comments

Comments
 (0)