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

9.5 KiB

id title
MoveHost MoveHost

Interface: MoveHost<TResource, TEvent>

Defined in: calendar/moveController.ts:17

Extends

Type Parameters

TResource

TResource extends Resource

TEvent

TEvent extends Event<TResource>

Properties

commitUpdate()

commitUpdate: (id, updates) => void;

Defined in: calendar/features/types.ts:41

Parameters

id

string

updates

Partial<Omit<TEvent, "id">>

Returns

void

Inherited from

CalendarHost.commitUpdate


editEvent()

editEvent: (eventId, updates, options?) => Promise<SaveEventResult>;

Defined in: calendar/features/types.ts:35

Parameters

eventId

string

updates

Partial<Omit<TEvent, "id">>

options?
dependsOn?

EventDependency[]

Returns

Promise<SaveEventResult>

Inherited from

CalendarHost.editEvent


editRecurringEvent()

editRecurringEvent: (eventId, updates, options) => Promise<SaveEventResult>;

Defined in: calendar/moveController.ts:23

Parameters

eventId

string

updates

Partial<Omit<TEvent, "id">>

options
occurrenceStart?

EventDateTimeInput

scope

RecurrenceEditScope

Returns

Promise<SaveEventResult>


fetchEventsForRange()

fetchEventsForRange: (start, end) => Promise<void>;

Defined in: calendar/features/types.ts:34

Parameters

start

string

end

string

Returns

Promise<void>

Inherited from

CalendarHost.fetchEventsForRange


getDaysWithEvents()

getDaysWithEvents: () => Day<TResource, TEvent>[];

Defined in: calendar/features/types.ts:26

Returns

Day<TResource, TEvent>[]

Inherited from

CalendarHost.getDaysWithEvents


getEvent()

getEvent: (id) => TEvent | undefined;

Defined in: calendar/features/types.ts:16

Parameters

id

string

Returns

TEvent | undefined

Inherited from

CalendarHost.getEvent


getEventMap()

getEventMap: (window?) => Map<string, TEvent[]>;

Defined in: calendar/features/types.ts:25

Parameters

window?
end

string

start

string

Returns

Map<string, TEvent[]>

Inherited from

CalendarHost.getEventMap


getEvents()

getEvents: () => TEvent[];

Defined in: calendar/features/types.ts:17

Returns

TEvent[]

Inherited from

CalendarHost.getEvents


getEventsByDate()

getEventsByDate: (date) => TEvent[];

Defined in: calendar/features/types.ts:27

Parameters

date

string

Returns

TEvent[]

Inherited from

CalendarHost.getEventsByDate


getOptions()

getOptions: () => object;

Defined in: calendar/features/types.ts:19

Returns

object

layout?
optional layout: LayoutOptions;
resources
resources: TResource[] | null;
timeZone
timeZone: TimeZoneLike;
workingTime
workingTime: WorkingTimeConfig;

Inherited from

CalendarHost.getOptions


getState()

getState: () => CalendarStore;

Defined in: calendar/features/types.ts:18

Returns

CalendarStore

Inherited from

CalendarHost.getState


goToSpecificPeriod()

goToSpecificPeriod: (isoDate) => void;

Defined in: calendar/features/types.ts:29

Parameters

isoDate

string

Returns

void

Inherited from

CalendarHost.goToSpecificPeriod


invalidateEvents()

invalidateEvents: () => void;

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

Returns

void

Inherited from

CalendarHost.invalidateEvents


removeEvent()

removeEvent: (id) => void;

Defined in: calendar/features/types.ts:40

Parameters

id

string

Returns

void

Inherited from

CalendarHost.removeEvent


resolveMasterEventId()

resolveMasterEventId: (eventId) => string;

Defined in: calendar/moveController.ts:22

Parameters

eventId

string

Returns

string


validateEventDependencies()

validateEventDependencies: (event, dependsOn) => object;

Defined in: calendar/features/types.ts:49

Parameters

event
end

string

id?

string

start

string

title

string

dependsOn

EventDependency[]

Returns

object

error?
optional error: EventMutationError;
valid
valid: boolean;

Inherited from

CalendarHost.validateEventDependencies


validateEventMove()

validateEventMove: (options) => ValidateMoveResult;

Defined in: calendar/moveController.ts:21

Parameters

options

ValidateMoveOptions

Returns

ValidateMoveResult


validateEventPlacement()

validateEventPlacement: (event) => object;

Defined in: calendar/features/types.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;

Inherited from

CalendarHost.validateEventPlacement


validateMove()

validateMove: (eventId, newStart, newEnd, newResources?, newConsumption?) => object;

Defined in: calendar/features/types.ts:42

Parameters

eventId

string

newStart

string

newEnd

string

newResources?

(string | TResource)[]

newConsumption?

number[]

Returns

object

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

Inherited from

CalendarHost.validateMove


write()

write: (ops, reason) => InvertibleOp<TEvent>[];

Defined in: calendar/features/types.ts:30

Parameters

ops

(IntentOp | InvertibleOp<TEvent>)[]

reason

string

Returns

InvertibleOp<TEvent>[]

Inherited from

CalendarHost.write