Function getCalendarForToday

  • getCalendarForToday(forceHttp?: boolean): Promise<undefined | Calendar>

  • Get a calendar, if available, for a the current date

    Example

    const calendar = await getCalendarToday()

    Remarks

    If an CalendarRepository is provided, and no Calendar is found, the function WILL NOT fall back to HTTP.

    Returns

    • when not found, returns undefined indicating the calendar is not available, e.g. 4th July 2022.

    Parameters

    • forceHttp: boolean = false

      bypass calendarRepository and force HTTP request

    Returns Promise<undefined | Calendar>

Settings

Member Visibility

Theme

Generated using TypeDoc