Skip to content

Commit 3f223b3

Browse files
ci: apply automated fixes
1 parent b3ea5fb commit 3f223b3

67 files changed

Lines changed: 4764 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/reference/classes/CalendarCore.md

Lines changed: 742 additions & 0 deletions
Large diffs are not rendered by default.

docs/reference/classes/DateCore.md

Lines changed: 326 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,326 @@
1+
---
2+
id: DateCore
3+
title: DateCore
4+
---
5+
6+
# Abstract Class: DateCore
7+
8+
Defined in: [calendar/date-core.ts:77](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/date-core.ts#L77)
9+
10+
## Extended by
11+
12+
- [`CalendarCore`](CalendarCore.md)
13+
14+
## Constructors
15+
16+
### Constructor
17+
18+
```ts
19+
new DateCore(options): DateCore;
20+
```
21+
22+
Defined in: [calendar/date-core.ts:86](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/date-core.ts#L86)
23+
24+
#### Parameters
25+
26+
##### options
27+
28+
[`DateCoreOptions`](../interfaces/DateCoreOptions.md)
29+
30+
#### Returns
31+
32+
`DateCore`
33+
34+
## Properties
35+
36+
### formatters
37+
38+
```ts
39+
formatters: object;
40+
```
41+
42+
Defined in: [calendar/date-core.ts:80](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/date-core.ts#L80)
43+
44+
#### date
45+
46+
```ts
47+
date: DateTimeFormat;
48+
```
49+
50+
#### dateTime
51+
52+
```ts
53+
dateTime: DateTimeFormat;
54+
```
55+
56+
#### time
57+
58+
```ts
59+
time: DateTimeFormat;
60+
```
61+
62+
***
63+
64+
### options
65+
66+
```ts
67+
options: ParsedDateCoreOptions;
68+
```
69+
70+
Defined in: [calendar/date-core.ts:79](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/date-core.ts#L79)
71+
72+
***
73+
74+
### store
75+
76+
```ts
77+
store: Store<CalendarStore>;
78+
```
79+
80+
Defined in: [calendar/date-core.ts:78](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/date-core.ts#L78)
81+
82+
## Methods
83+
84+
### canGoNextPeriod()
85+
86+
```ts
87+
canGoNextPeriod(): boolean;
88+
```
89+
90+
Defined in: [calendar/date-core.ts:407](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/date-core.ts#L407)
91+
92+
#### Returns
93+
94+
`boolean`
95+
96+
***
97+
98+
### canGoPreviousPeriod()
99+
100+
```ts
101+
canGoPreviousPeriod(): boolean;
102+
```
103+
104+
Defined in: [calendar/date-core.ts:376](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/date-core.ts#L376)
105+
106+
#### Returns
107+
108+
`boolean`
109+
110+
***
111+
112+
### changeViewMode()
113+
114+
```ts
115+
changeViewMode(newViewMode): void;
116+
```
117+
118+
Defined in: [calendar/date-core.ts:254](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/date-core.ts#L254)
119+
120+
#### Parameters
121+
122+
##### newViewMode
123+
124+
[`ViewMode`](../interfaces/ViewMode.md)
125+
126+
#### Returns
127+
128+
`void`
129+
130+
***
131+
132+
### formatDate()
133+
134+
```ts
135+
formatDate(date): string;
136+
```
137+
138+
Defined in: [calendar/date-core.ts:130](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/date-core.ts#L130)
139+
140+
#### Parameters
141+
142+
##### date
143+
144+
[`DateInput`](../type-aliases/DateInput.md)
145+
146+
#### Returns
147+
148+
`string`
149+
150+
***
151+
152+
### formatDateTime()
153+
154+
```ts
155+
formatDateTime(date): string;
156+
```
157+
158+
Defined in: [calendar/date-core.ts:138](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/date-core.ts#L138)
159+
160+
#### Parameters
161+
162+
##### date
163+
164+
[`DateInput`](../type-aliases/DateInput.md)
165+
166+
#### Returns
167+
168+
`string`
169+
170+
***
171+
172+
### formatTime()
173+
174+
```ts
175+
formatTime(date): string;
176+
```
177+
178+
Defined in: [calendar/date-core.ts:134](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/date-core.ts#L134)
179+
180+
#### Parameters
181+
182+
##### date
183+
184+
[`DateInput`](../type-aliases/DateInput.md)
185+
186+
#### Returns
187+
188+
`string`
189+
190+
***
191+
192+
### getCalendarDays()
193+
194+
```ts
195+
protected getCalendarDays(): PlainDate[];
196+
```
197+
198+
Defined in: [calendar/date-core.ts:161](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/date-core.ts#L161)
199+
200+
#### Returns
201+
202+
`PlainDate`[]
203+
204+
***
205+
206+
### getDaysNames()
207+
208+
```ts
209+
getDaysNames(weekday): string[];
210+
```
211+
212+
Defined in: [calendar/date-core.ts:243](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/date-core.ts#L243)
213+
214+
#### Parameters
215+
216+
##### weekday
217+
218+
`"long"` | `"short"`
219+
220+
#### Returns
221+
222+
`string`[]
223+
224+
***
225+
226+
### getFirstDayOfMonth()
227+
228+
```ts
229+
protected getFirstDayOfMonth(): PlainDate;
230+
```
231+
232+
Defined in: [calendar/date-core.ts:142](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/date-core.ts#L142)
233+
234+
#### Returns
235+
236+
`PlainDate`
237+
238+
***
239+
240+
### getFirstDayOfWeek()
241+
242+
```ts
243+
protected getFirstDayOfWeek(): PlainDate;
244+
```
245+
246+
Defined in: [calendar/date-core.ts:150](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/date-core.ts#L150)
247+
248+
#### Returns
249+
250+
`PlainDate`
251+
252+
***
253+
254+
### getWeekStartsOn()
255+
256+
```ts
257+
getWeekStartsOn(): number;
258+
```
259+
260+
Defined in: [calendar/date-core.ts:157](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/date-core.ts#L157)
261+
262+
#### Returns
263+
264+
`number`
265+
266+
***
267+
268+
### goToCurrentPeriod()
269+
270+
```ts
271+
goToCurrentPeriod(): void;
272+
```
273+
274+
Defined in: [calendar/date-core.ts:347](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/date-core.ts#L347)
275+
276+
#### Returns
277+
278+
`void`
279+
280+
***
281+
282+
### goToNextPeriod()
283+
284+
```ts
285+
goToNextPeriod(): void;
286+
```
287+
288+
Defined in: [calendar/date-core.ts:304](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/date-core.ts#L304)
289+
290+
#### Returns
291+
292+
`void`
293+
294+
***
295+
296+
### goToPreviousPeriod()
297+
298+
```ts
299+
goToPreviousPeriod(): void;
300+
```
301+
302+
Defined in: [calendar/date-core.ts:261](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/date-core.ts#L261)
303+
304+
#### Returns
305+
306+
`void`
307+
308+
***
309+
310+
### goToSpecificPeriod()
311+
312+
```ts
313+
goToSpecificPeriod(date): void;
314+
```
315+
316+
Defined in: [calendar/date-core.ts:360](https://github.com/TanStack/time/blob/main/packages/time/src/calendar/date-core.ts#L360)
317+
318+
#### Parameters
319+
320+
##### date
321+
322+
[`DateInput`](../type-aliases/DateInput.md)
323+
324+
#### Returns
325+
326+
`void`

0 commit comments

Comments
 (0)