date
DateRange
Defined in: src/utils/date/date.ts:14
Properties
| Property | Type | Defined in |
|---|---|---|
start? | Nil<DateInput> | src/utils/date/date.ts:15 |
end? | Nil<DateInput> | src/utils/date/date.ts:16 |
DateInput
type DateInput = Date | string | number;
Defined in: src/utils/date/date.ts:12
formatDate()
function formatDate(value): string;
Defined in: src/utils/date/date.ts:35
Formats date to include just the day, month and year. The exact date format is based on locale.
Parameters
| Parameter | Type |
|---|---|
value | DateInput |
Returns
string
Examples
// US format
"2/12/2019"
// PL format
"12.02.2019"
formatNilDate()
function formatNilDate(value): string | null;
Defined in: src/utils/date/date.ts:43
Formats date like formatDate, but replaces Nil and empty strings with null.
Parameters
| Parameter | Type |
|---|---|
value | Nil<DateInput> |
Returns
string | null
formatDateTime()
function formatDateTime(value): string;
Defined in: src/utils/date/date.ts:62
Formats date to include both day, month, year and hours, seconds. The exact date format is based on locale.
Parameters
| Parameter | Type |
|---|---|
value | DateInput |
Returns
string
Examples
// US format
"2/12/2019 11:31 PM"
// PL format
"12.02.2019 23:31"
formatNilDateTime()
function formatNilDateTime(value): string | null;
Defined in: src/utils/date/date.ts:70
Formats date like formatDateTime, but replaces Nil and empty strings with null.
Parameters
| Parameter | Type |
|---|---|
value | Nil<DateInput> |
Returns
string | null
formatDateRange()
function formatDateRange(dateRange, formatter): string | null;
Defined in: src/utils/date/date.ts:104
Formats a date range into a human-readable string using locale-aware formatting.
Parameters
| Parameter | Type |
|---|---|
dateRange | DateRange |
formatter | DateTimeFormat |
Returns
string | null
Examples
// Both dates provided
formatDateRange({ start: "2025-01-01", end: "2025-01-31" })
// Returns: "1/1/2025 – 1/31/2025"
// Only start date
formatDateRange({ start: "2025-01-01" })
// Returns: "from 1/1/2025"
// Only end date
formatDateRange({ end: "2025-01-31" })
// Returns: "ending 1/31/2025"
// No dates provided
formatDateRange({})
// Returns: null
formatNilDateRange()
function formatNilDateRange(dateRange, formatter): string | null;
Defined in: src/utils/date/date.ts:147
Formats a date range like formatDateRange, but returns null for nil date ranges.
Parameters
| Parameter | Type |
|---|---|
dateRange | Nil<DateRange> |
formatter | DateTimeFormat |
Returns
string | null
Examples
formatNilDateRange({ start: "2025-01-01", end: "2025-01-31" })
// Returns: "1/1/2025 – 1/31/2025"
formatNilDateRange(null)
// Returns: null