Meet npm Pro: unlimited public & private packages + package-based permissions.Learn more »

sundown

2.0.0 • Public • Published

sundown

Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads

Calculate sunrise and sunset times for a given date and location.

☁️ Installation

# Using npm 
npm install --save sundown
 
# Using yarn 
yarn add sundown

📋 Example

const sundown = require("sundown");
 
// Sunset today in Cluj-Napoca, Romania
const sundownInCluj = sundown(new Date(), 46.7712, 23.6236)
 
console.log(sundownInCluj)
// { sunrise:
//    { raw_time: [ 7, 27 ],
//      angle: 106.73357573114593,
//      time: '07:27',
//      formatted: '7:27, az = 106.73357573114593°' },
//   sunset:
//    { raw_time: [ 17, 53 ],
//      angle: 253.492509740339,
//      time: '17:53',
//      formatted: '17:53, az = 253.492509740339°' },
//   date: 2018-02-17T18:15:08.339Z,
//   coordinates: [ 46.7712, 0.06562111111111112 ] }

❓ Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.

  2. For bug reports and feature requests, open issues. 🐛

  3. For direct and quick help, you can use Codementor. 🚀

📝 Documentation

sundown(d, lat, lon)

Calculate sunset and sunrise times for given date and coordinates.

Params

  • Date d: 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.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💖 Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

  • Starring and sharing the projects you like 🚀

  • Buy me a book—I love books! I will remember you after years if you buy me one. 😁 📖

  • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

  • Support me on Patreon—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

  • Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! ❤️

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

📜 License

MIT © Ionică Bizău

Install

npm i sundown

DownloadsWeekly Downloads

3

Version

2.0.0

License

MIT

Unpacked Size

16.2 kB

Total Files

4

Last publish

Collaborators

  • avatar