1.0.3 • Published 4 years ago
sunriset v1.0.3
:cloud: Installation
# npm
npm install --save sunriset
# yarn
yarn add sunriset
Also support CDN:
<script src="https://www.jsdelivr.com/package/npm/sunriset"></script>
:package: Usage
Support UMD
packaging specification:
import sunriset from 'sunriset';
// OR
const sunriset = require('sunriset');
Example:
import sunriset from 'sunriset';
// Sunrise and sunset times of Beijing, December 27, 2019.
const longitude = 116.404;
const latitude = 39.908;
const getSuntime = sunriset(new Date(), latitude, longitude);
// {
// sunrise: {
// raw_time: [7, 35],
// angle: 120.28914956738069,
// time: '07:35',
// formatted: '7:35, az = 120.28914956738069°',
// },
// sunset: {
// raw_time: [16, 56],
// angle: 239.73664214319098,
// time: '16:56',
// formatted: '16:56, az = 239.73664214319098°',
// },
// date: '2019-12-27T01:25:08.897Z',
// coordinates: [39.908, 0.32334444444444443],
// }
:memo: Documentation
sunriset(date, lat, lon)
Calculate sunrise and sunset times for a given date and location.
Params
- Date
date
: The date you want to find the sun data for. - Number
lat
: The latitude. - Number
lon
: The longitude.
Return
- Object An object containing:
sunrise
(Object):raw_time
(Array): An array of two numbers (hours and minutes)time
(String): Formatted sunrise time (HH:mm
)
sunset
(Object):raw_time
(Array): An array of two numbers (hours and minutes)time
(String): Formatted sunset time (HH:mm
)
date
(Date): The provided date.coordinates
(Array): An array of latitude and longitude values.