Package Exports
- suncalc
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (suncalc) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
SunCalc
SunCalc is a tiny BSD-licensed JavaScript library for calculating sun position, sunlight phases (times for sunrise, sunset, dusk, etc.), moon position and lunar phase for the given location and time, created by Vladimir Agafonkin (@mourner) as a part of the SunCalc.net project.
Most calculations are based on the formulas given in the excellent Astronomy Answers articles about position of the sun and the planets. You can read about different twilight phases calculated by SunCalc in the Twilight article on Wikipedia.
Usage example
// get today's sunlight times for London
var times = SunCalc.getTimes(new Date(), 51.5, -0.1);
// format sunrise time from the Date object
var sunriseStr = times.sunrise.getHours() + ':' + times.sunrise.getMinutes();
// get position of the sun (azimuth and altitude) at today's sunrise
var sunrisePos = SunCalc.getPosition(times.sunrise, 51.5, -0.1);
// get sunrise azimuth in degrees
var sunriseAzimuth = sunrisePos.azimuth * 180 / Math.PI;
Using in a server environment
In addition to browsers, SunCalc can be used in server environments like Node,
and is available as an NPM package (npm install suncalc
).
var SunCalc = require('suncalc');
Reference
Sunlight times
SunCalc.getTimes(/*Date*/ date, /*Number*/ latitude, /*Number*/ longitude)
Returns an object with the following properties (each is a Date
object):
sunrise
: sunrise (top edge of the sun appears on the horizon)sunriseEnd
: sunrise ends (bottom edge of the sun touches the horizon)goldenHourEnd
: morning golden hour (soft light, best time for photography) endssolarNoon
: solar noon (sun is in the highest position)goldenHour
: evening golden hour startssunsetStart
: sunset starts (bottom edge of the sun touches the horizon)sunset
: sunset (sun disappears below the horizon, evening civil twilight starts)dusk
: dusk (evening nautical twilight starts)nauticalDusk
: nautical dusk (evening astronomical twilight starts)night
: night starts (dark enough for astronomical observations)nightEnd
: night ends (morning astronomical twilight starts)nauticalDawn
: nautical dawn (morning nautical twilight starts)dawn
: dawn (morning nautical twilight ends, morning civil twilight starts)nadir
: nadir (darkest moment of the night, sun is in the lowest position)
SunCalc.addTime(/*Number*/ angleInDegrees, /*String*/ morningName, /*String*/ eveningName)
Adds a custom time when the sun reaches the given angle to results returned by SunCalc.getTimes
.
Sun position
SunCalc.getPosition(/*Date*/ timeAndDate, /*Number*/ latitude, /*Number*/ longitude)
Returns an object with the following properties:
altitude
: sun altitude above the horizon in radians, e.g.0
at the horizon andPI/2
at the zenith (straight over your head)azimuth
: sun azimuth in radians (direction along the horizon, measured from south to west), e.g.0
is south andMath.PI * 3/4
is northwest
Moon position
SunCalc.getMoonPosition(/*Date*/ timeAndDate, /*Number*/ latitude, /*Number*/ longitude)
Returns an object with the following properties:
altitude
: moon altitude above the horizon in radiansazimuth
: moon azimuth in radiansdistance
: distance to moon in kilometers
Moon illumination
SunCalc.getMoonFraction(/*Date*/ timeAndDate)
Returns the illuminated fraction of the moon; varies from 0.0
(new moon) to 1.0
(full moon).