• Gets the details about the season for the current date of the specified calendar.

    Returns

    The current seasons data or an empty season data object if no current season can be found.

    Example

    SimpleCalendar.api.getCurrentSeason();
    // Returns an object like this
    // {
    // color: "#fffce8",
    // id: "4916a231",
    // name: "Spring",
    // description: "",
    // icon: "spring",
    // startingDay: 19,
    // startingMonth: 2,
    // sunriseTime: 21600,
    // sunsetTime: 64800
    // }

    Parameters

    • calendarId: string = 'active'

      Optional parameter to specify the ID of the calendar to get the current season from. If not provided the current active calendar will be used.

    Returns SeasonData