• Gets the details about the current month for the specified calendar.

    Returns

    The current month data or null if no current month can be found.

    Example

    SimpleCalendar.api.getCurrentMonth();
    // Returns an object like this:
    // {
    // abbreviation: "Jun",
    // id: "22b4b204",
    // intercalary: false,
    // intercalaryInclude: false,
    // name: "June",
    // description: "",
    // numberOfDays: 30,
    // numberOfLeapYearDays: 30,
    // numericRepresentation: 6,
    // numericRepresentationOffset: 0,
    // startingWeekday: null
    // }

    Parameters

    • calendarId: string = 'active'

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

    Returns MonthData | null