Skip to content

Commit aeb2f98

Browse files
ci: apply automated fixes
1 parent e29832f commit aeb2f98

5 files changed

Lines changed: 110 additions & 99 deletions

File tree

docs/reference/classes/CalendarCore.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ Defined in: [calendar/date-core.ts:79](https://github.com/TanStack/time/blob/mai
117117
addEvent(event, options?): Promise<SaveEventResult>;
118118
```
119119
120-
Defined in: [calendar/calendar.ts:1713](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1713)
120+
Defined in: [calendar/calendar.ts:1744](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1744)
121121
122122
Fetches events for the event's date range, validates placement
123123
constraints, and adds the event if valid. Returns a result
@@ -275,7 +275,7 @@ CalendarActions.changeViewMode
275275
commitAdd(event): void;
276276
```
277277
278-
Defined in: [calendar/calendar.ts:828](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L828)
278+
Defined in: [calendar/calendar.ts:859](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L859)
279279
280280
#### Parameters
281281
@@ -295,7 +295,7 @@ Defined in: [calendar/calendar.ts:828](https://github.com/TanStack/time/blob/mai
295295
commitUpdate(id, updates): void;
296296
```
297297
298-
Defined in: [calendar/calendar.ts:850](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L850)
298+
Defined in: [calendar/calendar.ts:881](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L881)
299299
300300
#### Parameters
301301
@@ -322,7 +322,7 @@ createDependency(
322322
type): object;
323323
```
324324
325-
Defined in: [calendar/calendar.ts:1865](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1865)
325+
Defined in: [calendar/calendar.ts:1896](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1896)
326326
327327
Creates a dependency link from source to target event.
328328
If the target event starts before the source event ends, it will optionally reschedule the target.
@@ -371,7 +371,7 @@ CalendarActions.createDependency
371371
createResizeController(options): ResizeController<TResource, TEvent>;
372372
```
373373
374-
Defined in: [calendar/calendar.ts:1400](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1400)
374+
Defined in: [calendar/calendar.ts:1431](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1431)
375375
376376
#### Parameters
377377
@@ -394,7 +394,7 @@ editEvent(
394394
options?): Promise<SaveEventResult>;
395395
```
396396
397-
Defined in: [calendar/calendar.ts:1767](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1767)
397+
Defined in: [calendar/calendar.ts:1798](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1798)
398398
399399
Fetches events for the event's date range, validates move constraints
400400
(and cascading dependents), and updates the event if valid.
@@ -729,7 +729,7 @@ CalendarActions.getEventProps
729729
getEvents(): TEvent[];
730730
```
731731
732-
Defined in: [calendar/calendar.ts:1339](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1339)
732+
Defined in: [calendar/calendar.ts:1370](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1370)
733733
734734
Returns a snapshot of all events currently managed by the calendar (including those outside the visible range).
735735
@@ -779,7 +779,7 @@ CalendarActions.getEventsByDate
779779
getEventsByResource(): Map<TResource["id"], TEvent[]>;
780780
```
781781
782-
Defined in: [calendar/calendar.ts:2185](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L2185)
782+
Defined in: [calendar/calendar.ts:2216](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L2216)
783783
784784
Groups visible events by resource, merging multi-day segments back to full-span events.
785785
@@ -851,7 +851,7 @@ readonly `object`[]
851851
getMasterEvent(event): TEvent;
852852
```
853853
854-
Defined in: [calendar/calendar.ts:1334](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1334)
854+
Defined in: [calendar/calendar.ts:1365](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1365)
855855
856856
Returns the master event for a given occurrence (or the event itself if it is already the master).
857857
@@ -879,7 +879,7 @@ CalendarActions.getMasterEvent
879879
getTimelineLayout(): TimelineLayout<TResource, TEvent>;
880880
```
881881
882-
Defined in: [calendar/calendar.ts:2189](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L2189)
882+
Defined in: [calendar/calendar.ts:2220](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L2220)
883883
884884
Computes horizontal timeline layout with event positions, lane assignments, and current time marker.
885885
@@ -933,7 +933,7 @@ getUnavailabilityDetails(
933933
options?): object[];
934934
```
935935
936-
Defined in: [calendar/calendar.ts:2070](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L2070)
936+
Defined in: [calendar/calendar.ts:2101](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L2101)
937937
938938
#### Parameters
939939
@@ -967,7 +967,7 @@ Defined in: [calendar/calendar.ts:2070](https://github.com/TanStack/time/blob/ma
967967
getUnavailableRanges(date, options?): UnavailableRange[];
968968
```
969969
970-
Defined in: [calendar/calendar.ts:1981](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1981)
970+
Defined in: [calendar/calendar.ts:2012](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L2012)
971971
972972
Retrieves unavailable time ranges for a specific date based on resource availability.
973973
@@ -1047,7 +1047,7 @@ CalendarActions.goToCurrentPeriod
10471047
goToNextOccurrence(eventId, fromDate?): void;
10481048
```
10491049
1050-
Defined in: [calendar/calendar.ts:1351](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1351)
1050+
Defined in: [calendar/calendar.ts:1382](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1382)
10511051
10521052
Navigates to the next occurrence of a recurring event after fromDate (defaults to activeDate).
10531053
No-op when the event is not recurring or has no future occurrences.
@@ -1104,7 +1104,7 @@ CalendarActions.goToNextPeriod
11041104
goToPreviousOccurrence(eventId, fromDate?): void;
11051105
```
11061106
1107-
Defined in: [calendar/calendar.ts:1375](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1375)
1107+
Defined in: [calendar/calendar.ts:1406](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1406)
11081108
11091109
Navigates to the previous occurrence of a recurring event before fromDate (defaults to activeDate).
11101110
No-op when the event is not recurring or is already at the first occurrence.
@@ -1229,7 +1229,7 @@ CalendarActions.groupDaysBy
12291229
redo(): void;
12301230
```
12311231
1232-
Defined in: [calendar/calendar.ts:822](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L822)
1232+
Defined in: [calendar/calendar.ts:850](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L850)
12331233
12341234
Re-applies the last undone action.
12351235
@@ -1251,7 +1251,7 @@ CalendarActions.redo
12511251
removeEvent(id): void;
12521252
```
12531253
1254-
Defined in: [calendar/calendar.ts:1954](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1954)
1254+
Defined in: [calendar/calendar.ts:1985](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1985)
12551255
12561256
Removes an event by ID.
12571257
@@ -1279,7 +1279,7 @@ CalendarActions.removeEvent
12791279
undo(): void;
12801280
```
12811281
1282-
Defined in: [calendar/calendar.ts:816](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L816)
1282+
Defined in: [calendar/calendar.ts:841](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L841)
12831283
12841284
Reverts the last mutating action (commitAdd, commitUpdate, removeEvent).
12851285
@@ -1301,7 +1301,7 @@ CalendarActions.undo
13011301
validateEventDependencies(event, dependsOn): object;
13021302
```
13031303
1304-
Defined in: [calendar/calendar.ts:1615](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1615)
1304+
Defined in: [calendar/calendar.ts:1646](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1646)
13051305
13061306
Validates if placing an event with a specific start time satisfies all dependency constraints.
13071307
@@ -1359,7 +1359,7 @@ CalendarActions.validateEventDependencies
13591359
validateEventPlacement(event): object;
13601360
```
13611361
1362-
Defined in: [calendar/calendar.ts:1672](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1672)
1362+
Defined in: [calendar/calendar.ts:1703](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1703)
13631363
13641364
Validates whether a new event (not yet added to the calendar) can be
13651365
placed at the given time slot without violating resource availability.
@@ -1428,7 +1428,7 @@ validateMove(
14281428
newConsumption?): object;
14291429
```
14301430
1431-
Defined in: [calendar/calendar.ts:1406](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1406)
1431+
Defined in: [calendar/calendar.ts:1437](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L1437)
14321432
14331433
Checks whether moving `eventId` to `[newStart, newEnd]` — and cascading
14341434
all finish-to-start dependents — would violate any resource availability.
@@ -1491,7 +1491,7 @@ CalendarActions.validateMove
14911491
validateResize(options): ValidateResizeResult;
14921492
```
14931493
1494-
Defined in: [calendar/calendar.ts:2475](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L2475)
1494+
Defined in: [calendar/calendar.ts:2506](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/calendar.ts#L2506)
14951495
14961496
#### Parameters
14971497

docs/reference/functions/getTimeClient.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: getTimeClient
99
function getTimeClient(): TimeClient;
1010
```
1111

12-
Defined in: [client/TimeClient.ts:94](https://github.com/TanStack/time/blob/main/packages/time/src/client/TimeClient.ts#L94)
12+
Defined in: [client/TimeClient.ts:87](https://github.com/TanStack/time/blob/main/packages/time/src/client/TimeClient.ts#L87)
1313

1414
Get the global TimeClient instance
1515

docs/reference/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ title: "@tanstack/time"
5959
- [SinceOptions](interfaces/SinceOptions.md)
6060
- [StartOfOptions](interfaces/StartOfOptions.md)
6161
- [SubtractOptions](interfaces/SubtractOptions.md)
62+
- [TimeEventInfo](interfaces/TimeEventInfo.md)
6263
- [TimeEventMap](interfaces/TimeEventMap.md)
6364
- [TimelineEventLayout](interfaces/TimelineEventLayout.md)
6465
- [TimelineLayout](interfaces/TimelineLayout.md)
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
id: TimeEventInfo
3+
title: TimeEventInfo
4+
---
5+
6+
# Interface: TimeEventInfo
7+
8+
Defined in: [client/TimeClient.ts:7](https://github.com/TanStack/time/blob/main/packages/time/src/client/TimeClient.ts#L7)
9+
10+
## Properties
11+
12+
### end
13+
14+
```ts
15+
end: string;
16+
```
17+
18+
Defined in: [client/TimeClient.ts:11](https://github.com/TanStack/time/blob/main/packages/time/src/client/TimeClient.ts#L11)
19+
20+
***
21+
22+
### eventId
23+
24+
```ts
25+
eventId: string;
26+
```
27+
28+
Defined in: [client/TimeClient.ts:8](https://github.com/TanStack/time/blob/main/packages/time/src/client/TimeClient.ts#L8)
29+
30+
***
31+
32+
### eventTitle
33+
34+
```ts
35+
eventTitle: string;
36+
```
37+
38+
Defined in: [client/TimeClient.ts:9](https://github.com/TanStack/time/blob/main/packages/time/src/client/TimeClient.ts#L9)
39+
40+
***
41+
42+
### start
43+
44+
```ts
45+
start: string;
46+
```
47+
48+
Defined in: [client/TimeClient.ts:10](https://github.com/TanStack/time/blob/main/packages/time/src/client/TimeClient.ts#L10)

0 commit comments

Comments
 (0)