0
Fork 0
mirror of https://github.com/TanStack/time.git synced 2026-11-16 19:09:47 +00:00
time/docs/reference/interfaces/AvailabilityApi.md
2026-08-22 23:22:16 +00:00

3.4 KiB

id title
AvailabilityApi AvailabilityApi

Interface: AvailabilityApi<TResource, TEvent>

Defined in: calendar/features/availability.ts:23

Type Parameters

TResource

TResource extends Resource

TEvent

TEvent extends Event<TResource>

Properties

checkEventAvailability()

checkEventAvailability: (event, newStart, newEnd, newResources?, newConsumption?) => AvailabilityConflict | null;

Defined in: calendar/features/availability.ts:46

Parameters

event

TEvent

newStart

string

newEnd

string

newResources?

(string | TResource)[]

newConsumption?

number[]

Returns

AvailabilityConflict | null


getDaySpanConflicts()

getDaySpanConflicts: (options) => AvailabilityConflict[];

Defined in: calendar/features/availability.ts:38

Parameters

options
date

string

endMinutes

number

event?

TEvent

eventId

string

resourceIds

TResource["id"][]

startMinutes

number

Returns

AvailabilityConflict[]


getUnavailabilityDetails()

getUnavailabilityDetails: (date, startMinutes, endMinutes, options?) => UnavailabilityDetail[];

Defined in: calendar/features/availability.ts:32

Parameters

date

string

startMinutes

number

endMinutes

number

options?
resourceIds?

TResource["id"][]

Returns

UnavailabilityDetail[]


getUnavailableMinuteRanges()

getUnavailableMinuteRanges: (date, options?) => UnavailableTimeRange[];

Defined in: calendar/features/availability.ts:28

Parameters

date

string

options?
resourceIds?

TResource["id"][]

Returns

UnavailableTimeRange[]


getUnavailableRanges()

getUnavailableRanges: (date, options?) => UnavailableRange[];

Defined in: calendar/features/availability.ts:24

Parameters

date

string

options?
resourceIds?

TResource["id"][]

Returns

UnavailableRange[]


validateEventPlacement()

validateEventPlacement: (event) => object;

Defined in: calendar/features/availability.ts:53

Parameters

event
calendarId?

string

consumption?

number[]

end

string

id?

string

resources?

(string | TResource)[]

start

string

title

string

Returns

object

blocked
blocked: boolean;
message?
optional message: string;