Siddhanta Parity API Documentation - v1.3.0
    Preparing search index...
    • Searches for a solar eclipse visible at a specific location on the Earth's surface.

      This function finds the first solar eclipse that occurs after startTime. A solar eclipse may be partial, annular, or total. See LocalSolarEclipseInfo for more information.

      To find a series of solar eclipses, call this function once, then keep calling NextLocalSolarEclipse as many times as desired, passing in the peak value returned from the previous call.

      IMPORTANT: An eclipse reported by this function might be partly or completely invisible to the observer due to the time of day. See LocalSolarEclipseInfo for more information about this topic.

      Parameters

      • startTime: FlexibleDateTime

        The date and time for starting the search for a solar eclipse.

      • observer: Observer

        The geographic location of the observer.

      Returns LocalSolarEclipseInfo