• Gets the details about the current weekday.

    Returns

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

    Example

    SimpleCalendar.api.getCurrentWeekday();
    // Returns an object like this
    // {
    // id: "b40f3a20",
    // name: "Tuesday",
    // abbreviation: "Tu",
    // description: "",
    // numericRepresentation: 3,
    // restday: false
    // }

    Parameters

    • calendarId: string = 'active'

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

    Returns WeekdayData | null