Api
Types
TypeScript types and enums exported by availability-js.
Types
DAY_OF_WEEK
enum DAY_OF_WEEK {
Sunday = "Sunday",
Monday = "Monday",
Tuesday = "Tuesday",
Wednesday = "Wednesday",
Thursday = "Thursday",
Friday = "Friday",
Saturday = "Saturday"
}TimeString
type TimeString = `${number}${number}:${number}${number}`;24-hour format, e.g. "09:00", "17:30".
TimeRange
type TimeRange = {
start: TimeString;
end: TimeString;
};TimeSlot
interface TimeSlot extends TimeRange {
isAvailable: boolean;
}WeeklySchedule
type WeeklySchedule = {
schedule: DailySchedule[];
timezone: string;
options?: {
from?: Date;
until?: Date;
};
};DailySchedule
interface DailySchedule extends TimeRange {
dayOfWeek: DAY_OF_WEEK;
}DayOverride
interface DayOverride {
date: Date;
isAvailable: boolean;
timeRanges: TimeRange[] | null;
}isAvailable: falseandtimeRanges: null= full day unavailableisAvailable: trueandtimeRanges: [...]= custom hours for that date
Booking
interface Booking {
startTime: string; // UTC ISO string
endTime: string; // UTC ISO string
}