Skip to content

Commit e56eab8

Browse files
ci: apply automated fixes
1 parent 68abe50 commit e56eab8

28 files changed

Lines changed: 1464 additions & 0 deletions

docs/reference/functions/add.md

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
id: add
3+
title: add
4+
---
5+
6+
# Function: add()
7+
8+
```ts
9+
function add(input, options): object;
10+
```
11+
12+
Defined in: [add/add.ts:13](https://github.com/TanStack/time/blob/main/packages/time/src/date/add/add.ts#L13)
13+
14+
add
15+
Adds a duration to a date/time instance
16+
17+
## Parameters
18+
19+
### input
20+
21+
`DateInput`
22+
23+
### options
24+
25+
[`AddOptions`](../interfaces/AddOptions.md)
26+
27+
## Returns
28+
29+
`object`
30+
31+
### asDate()
32+
33+
```ts
34+
asDate: () => Date;
35+
```
36+
37+
#### Returns
38+
39+
`Date`
40+
41+
### asEpoch()
42+
43+
```ts
44+
asEpoch: () => number;
45+
```
46+
47+
#### Returns
48+
49+
`number`
50+
51+
### asLong()
52+
53+
```ts
54+
asLong: () => string;
55+
```
56+
57+
#### Returns
58+
59+
`string`
60+
61+
### asString()
62+
63+
```ts
64+
asString: () => string;
65+
```
66+
67+
#### Returns
68+
69+
`string`
70+
71+
### asZonedDateTime()
72+
73+
```ts
74+
asZonedDateTime: () => ZonedDateTime;
75+
```
76+
77+
#### Returns
78+
79+
`ZonedDateTime`
80+
81+
### calendar
82+
83+
```ts
84+
calendar: string = options.calendar;
85+
```
86+
87+
### options
88+
89+
```ts
90+
options: Required<DateOptions>;
91+
```
92+
93+
### returnFormat
94+
95+
```ts
96+
returnFormat: ReturnFormat;
97+
```
98+
99+
### timeZone
100+
101+
```ts
102+
timeZone: string = options.timeZone;
103+
```
104+
105+
### value
106+
107+
```ts
108+
value: string;
109+
```

docs/reference/functions/endOf.md

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
id: endOf
3+
title: endOf
4+
---
5+
6+
# Function: endOf()
7+
8+
```ts
9+
function endOf(input, options): object;
10+
```
11+
12+
Defined in: [endOf/endOf.ts:23](https://github.com/TanStack/time/blob/main/packages/time/src/date/endOf/endOf.ts#L23)
13+
14+
endOf
15+
Returns the end of a given unit for a date/time instance
16+
17+
## Parameters
18+
19+
### input
20+
21+
`DateInput`
22+
23+
### options
24+
25+
[`EndOfOptions`](../interfaces/EndOfOptions.md)
26+
27+
## Returns
28+
29+
`object`
30+
31+
### asDate()
32+
33+
```ts
34+
asDate: () => Date;
35+
```
36+
37+
#### Returns
38+
39+
`Date`
40+
41+
### asEpoch()
42+
43+
```ts
44+
asEpoch: () => number;
45+
```
46+
47+
#### Returns
48+
49+
`number`
50+
51+
### asLong()
52+
53+
```ts
54+
asLong: () => string;
55+
```
56+
57+
#### Returns
58+
59+
`string`
60+
61+
### asString()
62+
63+
```ts
64+
asString: () => string;
65+
```
66+
67+
#### Returns
68+
69+
`string`
70+
71+
### asZonedDateTime()
72+
73+
```ts
74+
asZonedDateTime: () => ZonedDateTime;
75+
```
76+
77+
#### Returns
78+
79+
`ZonedDateTime`
80+
81+
### calendar
82+
83+
```ts
84+
calendar: string = options.calendar;
85+
```
86+
87+
### options
88+
89+
```ts
90+
options: Required<DateOptions>;
91+
```
92+
93+
### returnFormat
94+
95+
```ts
96+
returnFormat: ReturnFormat;
97+
```
98+
99+
### timeZone
100+
101+
```ts
102+
timeZone: string = options.timeZone;
103+
```
104+
105+
### value
106+
107+
```ts
108+
value: string;
109+
```

docs/reference/functions/equals.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
id: equals
3+
title: equals
4+
---
5+
6+
# Function: equals()
7+
8+
```ts
9+
function equals(
10+
date1,
11+
date2,
12+
unit,
13+
options?): boolean;
14+
```
15+
16+
Defined in: [equals/equals.ts:22](https://github.com/TanStack/time/blob/main/packages/time/src/date/equals/equals.ts#L22)
17+
18+
equals
19+
Returns true if two date/time instances are equal at the specified unit level
20+
21+
## Parameters
22+
23+
### date1
24+
25+
`DateInput`
26+
27+
### date2
28+
29+
`DateInput`
30+
31+
### unit
32+
33+
[`EqualsUnit`](../type-aliases/EqualsUnit.md)
34+
35+
### options?
36+
37+
[`EqualsOptions`](../interfaces/EqualsOptions.md)
38+
39+
## Returns
40+
41+
`boolean`
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
id: isAfter
3+
title: isAfter
4+
---
5+
6+
# Function: isAfter()
7+
8+
```ts
9+
function isAfter(
10+
date1,
11+
date2,
12+
options?): boolean;
13+
```
14+
15+
Defined in: [isAfter/isAfter.ts:12](https://github.com/TanStack/time/blob/main/packages/time/src/date/isAfter/isAfter.ts#L12)
16+
17+
isAfter
18+
Returns true if the first date/time instance is after the second date/time instance
19+
20+
## Parameters
21+
22+
### date1
23+
24+
`DateInput`
25+
26+
### date2
27+
28+
`DateInput`
29+
30+
### options?
31+
32+
[`IsAfterOptions`](../interfaces/IsAfterOptions.md)
33+
34+
## Returns
35+
36+
`boolean`
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
id: isBefore
3+
title: isBefore
4+
---
5+
6+
# Function: isBefore()
7+
8+
```ts
9+
function isBefore(
10+
date1,
11+
date2,
12+
options?): boolean;
13+
```
14+
15+
Defined in: [isBefore/isBefore.ts:12](https://github.com/TanStack/time/blob/main/packages/time/src/date/isBefore/isBefore.ts#L12)
16+
17+
isBefore
18+
Returns true if the first date/time instance is before the second date/time instance
19+
20+
## Parameters
21+
22+
### date1
23+
24+
`DateInput`
25+
26+
### date2
27+
28+
`DateInput`
29+
30+
### options?
31+
32+
[`IsBeforeOptions`](../interfaces/IsBeforeOptions.md)
33+
34+
## Returns
35+
36+
`boolean`
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
id: isSameOrAfter
3+
title: isSameOrAfter
4+
---
5+
6+
# Function: isSameOrAfter()
7+
8+
```ts
9+
function isSameOrAfter(
10+
date1,
11+
date2,
12+
options): boolean;
13+
```
14+
15+
Defined in: [isSameOrAfter/isSameOrAfter.ts:25](https://github.com/TanStack/time/blob/main/packages/time/src/date/isSameOrAfter/isSameOrAfter.ts#L25)
16+
17+
isSameOrAfter
18+
Returns true if the first date/time instance is the same as or after the second date/time instance at the specified unit level
19+
20+
## Parameters
21+
22+
### date1
23+
24+
`DateInput`
25+
26+
### date2
27+
28+
`DateInput`
29+
30+
### options
31+
32+
[`IsSameOrAfterOptions`](../interfaces/IsSameOrAfterOptions.md)
33+
34+
## Returns
35+
36+
`boolean`

0 commit comments

Comments
 (0)