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:325

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:329

The days of the week that are available for appointments.


blockWeekends?​

readonly optional blockWeekends?: boolean

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

Blocks all weekends

If provided, it will override the availableDays.


blockCurrentDay?​

readonly optional blockCurrentDay?: boolean

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

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:356

The current day stays available until the specified time, in HH:MM (24-hour) format.

For example, "14:00" keeps today bookable up to 2:00 PM; after that, today is no longer offered.

NOTE: the previous doc comment here described the inverse ("unavailable until 2:00 PM"). It was wrong: consumers disable the current day once the current time is past this value, and the Studio UI ("same-day booking allowed until…") has always matched that behavior rather than the old comment. Corrected here so the semantics cannot be implemented backwards downstream.

Same meaning as AvailabilityClass.currentDayAvailableUntil, which overrides this for jobs resolved to a class.


blockNextBusinessDays?​

readonly optional blockNextBusinessDays?: number

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

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.