Interface TimeFrame

Represents a time frame indicating when a restriction is active.

interface TimeFrame {
    daysOfMonth: null | DaysOfMonth;
    endDate: null | string;
    fromTime: null | string;
    repeatYearly: null | boolean;
    startDate: null | string;
    timeZone: null | string;
    toTime: null | string;
    weekdays: null | WeekDay[];
}

Properties

daysOfMonth: null | DaysOfMonth

Days of the month filtering (e.g., even or odd days), pass null for all dates.

endDate: null | string

End date in "YYYY-MM-DD" format.

fromTime: null | string

Start time in 24-hour format ("HH:MM").

repeatYearly: null | boolean

Whether the time frame repeats yearly.

startDate: null | string

Start date in "YYYY-MM-DD" format.

timeZone: null | string

Time zone identifier (e.g., "Asia/Jerusalem").

toTime: null | string

End time in 24-hour format ("HH:MM").

weekdays: null | WeekDay[]

Bitmask representing the days of the week when active.