Skip to main content

TimeSlotSchedule

Stentor API Reference

Stentor API Reference / stentor-models/src / TimeSlotSchedule

Interface: TimeSlotSchedule

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

Defines which appointment times a date/time picker offers.

Offerings are derived from this definition alone — there is no CRM or field-service availability lookup behind it, so a schedule describes when a business is open, not which times are still free.

Properties​

timezone​

timezone: string

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

IANA timezone the schedule is expressed in, for example "America/New_York".

Required, because every other time in this object is a wall-clock time in the business's zone and a visitor is frequently in a different one.

slotMinutes?​

optional slotMinutes?: number

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

Minutes between generated start times. Defaults to 30.

durationMinutes?​

optional durationMinutes?: number

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

How long an appointment lasts, in minutes. When set, each generated offering carries an end. When omitted, offerings are discrete start times with no stated end.

days?​

optional days?: object

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

Spans the business is open, per weekday. More than one span expresses a break in the day. A weekday that is missing or empty is closed.

monday?​

optional monday?: TimeSpan[]

tuesday?​

optional tuesday?: TimeSpan[]

wednesday?​

optional wednesday?: TimeSpan[]

thursday?​

optional thursday?: TimeSpan[]

friday?​

optional friday?: TimeSpan[]

saturday?​

optional saturday?: TimeSpan[]

sunday?​

optional sunday?: TimeSpan[]

exceptions?​

optional exceptions?: ScheduleException[]

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

Date-specific overrides of days, for holidays and one-off hours.

leadTimeMinutes?​

optional leadTimeMinutes?: number

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

Hides offerings starting within this many minutes of now, so a visitor cannot book a time the business has no chance to staff.

horizonDays?​

optional horizonDays?: number

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

How many days ahead the picker allows. Defaults to 60.

offerings?​

optional offerings?: TimeOffering[]

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

An explicit list of offerings. When present this replaces generation — days, slotMinutes and durationMinutes are not used.

This is how a schedule expresses named windows, or a mix of windows and discrete times, that a uniform interval cannot produce.

capacity?​

optional capacity?: SlotCapacityPolicy

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

Note​