Skip to content

Commit 548c920

Browse files
Merge branch 'alpha' of github.com:TanStack/time into alpha
2 parents b19c47d + deb652e commit 548c920

30 files changed

Lines changed: 334 additions & 84 deletions

docs/reference/functions/add.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Adds a duration to a date/time instance
1818

1919
### input
2020

21-
`DateInput`
21+
[`DateInput`](../type-aliases/DateInput.md)
2222

2323
### options
2424

docs/reference/functions/endOf.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Returns the end of a given unit for a date/time instance
1818

1919
### input
2020

21-
`DateInput`
21+
[`DateInput`](../type-aliases/DateInput.md)
2222

2323
### options
2424

docs/reference/functions/equals.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ Returns true if two date/time instances are equal at the specified unit level
2222

2323
### date1
2424

25-
`DateInput`
25+
[`DateInput`](../type-aliases/DateInput.md)
2626

2727
### date2
2828

29-
`DateInput`
29+
[`DateInput`](../type-aliases/DateInput.md)
3030

3131
### unit
3232

docs/reference/functions/format.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
id: format
3+
title: format
4+
---
5+
6+
# Function: format()
7+
8+
```ts
9+
function format(date, formatOptions?): string;
10+
```
11+
12+
Defined in: [format/format.ts:32](https://github.com/TanStack/time/blob/main/packages/time/src/date/format/format.ts#L32)
13+
14+
format
15+
Formats a date/time instance using Intl.DateTimeFormat
16+
17+
## Parameters
18+
19+
### date
20+
21+
[`DateInput`](../type-aliases/DateInput.md)
22+
23+
The date to format
24+
25+
### formatOptions?
26+
27+
[`FormatDateOptions`](../interfaces/FormatDateOptions.md)
28+
29+
Formatting options including type, locale, and Intl.DateTimeFormat options
30+
31+
## Returns
32+
33+
`string`

docs/reference/functions/intersects.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Returns true if the date/time instance intersects with the range (i.e., is withi
1818

1919
### date
2020

21-
`DateInput`
21+
[`DateInput`](../type-aliases/DateInput.md)
2222

2323
The date to check
2424

docs/reference/functions/isAfter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ Returns true if the first date/time instance is after the second date/time insta
2121

2222
### date1
2323

24-
`DateInput`
24+
[`DateInput`](../type-aliases/DateInput.md)
2525

2626
### date2
2727

28-
`DateInput`
28+
[`DateInput`](../type-aliases/DateInput.md)
2929

3030
### options?
3131

docs/reference/functions/isBefore.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ Returns true if the first date/time instance is before the second date/time inst
2121

2222
### date1
2323

24-
`DateInput`
24+
[`DateInput`](../type-aliases/DateInput.md)
2525

2626
### date2
2727

28-
`DateInput`
28+
[`DateInput`](../type-aliases/DateInput.md)
2929

3030
### options?
3131

docs/reference/functions/isBetween.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Returns true if the date/time instance is between the start and end of the range
1818

1919
### date
2020

21-
`DateInput`
21+
[`DateInput`](../type-aliases/DateInput.md)
2222

2323
The date to check
2424

docs/reference/functions/isSameOrAfter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ Returns true if the first date/time instance is the same as or after the second
2121

2222
### date1
2323

24-
`DateInput`
24+
[`DateInput`](../type-aliases/DateInput.md)
2525

2626
### date2
2727

28-
`DateInput`
28+
[`DateInput`](../type-aliases/DateInput.md)
2929

3030
### options
3131

docs/reference/functions/isSameOrBefore.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ Returns true if the first date/time instance is the same as or before the second
2121

2222
### date1
2323

24-
`DateInput`
24+
[`DateInput`](../type-aliases/DateInput.md)
2525

2626
### date2
2727

28-
`DateInput`
28+
[`DateInput`](../type-aliases/DateInput.md)
2929

3030
### options
3131

0 commit comments

Comments
 (0)