Skip to main content

BusyDayDescription

Stentor API Reference


Stentor API Reference / stentor-models/src / BusyDayDescription

Interface: BusyDayDescription

Defined in: packages/stentor-models/src/Form/FormField.ts:323

Configuration for marking days as busy/unavailable in date selection.

Used to control which days can be selected in date input fields, typically for appointment scheduling or availability management.

Properties​

availableDays?​

readonly optional availableDays?: DayOfWeek[]

Defined in: packages/stentor-models/src/Form/FormField.ts:327

The days of the week that are available for appointments.


blockWeekends?​

readonly optional blockWeekends?: boolean

Defined in: packages/stentor-models/src/Form/FormField.ts:333

Blocks all weekends

If provided, it will override the availableDays.


blockCurrentDay?​

readonly optional blockCurrentDay?: boolean

Defined in: packages/stentor-models/src/Form/FormField.ts:340

Blocks the current day.

If it is a weekend and weekends are not blocked, it will be blocked. If it is a weekend and weekends are blocked, then it will be disregarded.


currentDayAvailableUntil?​

readonly optional currentDayAvailableUntil?: string

Defined in: packages/stentor-models/src/Form/FormField.ts:346

Blocks the current day until the specified time. This is in the format of HH:MM.

For example, "14:00" would make the current day unavailable until 2:00 PM.


blockNextBusinessDays?​

readonly optional blockNextBusinessDays?: number

Defined in: packages/stentor-models/src/Form/FormField.ts:354

Blocks the next number of business days.

One business day will block the next business day.

If this is set, it will override the availableDays, blockWeekends, and blockCurrentDay.