Astro Data
Astro Data, by GrumpTech, is a module that provides astronomical event data, like sunrise and sunset. This module makes use of the application programming interface (API) provided by the United States Naval Observatory.
Change Log
The change history can be viewed here
Security Policy
Please refer to our security policy for information on which versions are receiving security updates and how to report security vulnerabilities.
Installation
To install the plugin:
npm install grumptech-astrodata
Usage
The module allows the user to query for astronomical evend data for the specified day. Please refer to the documentation for details.
API
The module provides the following application programming interface.
- Version: Read only property for the module version.
- RSTOneDayData: Read only property for the result of the most recent request for One Day Data.
- RequestAstronomicalOneDayData: Initiates a request for astronomical data according to the API provided by the United States Naval Observatory.
- IsLocationValid: Validates the location latitude and longitude provided.
Events
The module publishes the following events:
- API_ASTRONOMICAL_DATA_EVENTS.API_EVENT_DATA_BUSY ('busy'): Event fired when the busy state changes.
- API_ASTRONOMICAL_DATA_EVENTS.API_EVENT_DATA_REQUEST_COMPLETE ('request_complete'): Event fired when the request has been processed.
Known Issues and Planned Enhancements
Refer to the bugs and enhancements listed here
Contributing
- Fork it!
- Create your feature/fix branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request
Credits
Many thanks to the Astronomical Applications Department of the United States Naval Observatory for making this API available to the general public.
License
Refer to LICENSE.md for information regarding licensincg of this source code.