date
date
Type Aliases
DateRangeValue
type DateRangeValue = object;Defined in: date/wire.ts:7
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
end |
readonly |
string |
date/wire.ts:9 |
start |
readonly |
string |
date/wire.ts:8 |
DateRangeWire
type DateRangeWire = object;Defined in: date/wire.ts:13
Nullable wire shape for date-range columns and effective ranges.
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
end? |
readonly |
string | null |
date/wire.ts:15 |
start? |
readonly |
string | null |
date/wire.ts:14 |
FormatInstantOptions
type FormatInstantOptions = Intl.DateTimeFormatOptions & object;Defined in: date/display.ts:4
Type Declaration
locale?
optional locale?: string;TimeOfDayRange
type TimeOfDayRange = object;Defined in: date/index.ts:17
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
end |
readonly |
string |
date/index.ts:19 |
start |
readonly |
string |
date/index.ts:18 |
WeekdayName
type WeekdayName = "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun";Defined in: date/index.ts:15
Functions
dateWithinRange()
function dateWithinRange(date, range): boolean;Defined in: date/index.ts:44
Inclusive range check for stored UTC instants.
Parameters
| Parameter | Type |
|---|---|
date |
Date |
range |
| DateRangeWire | null | undefined |
Returns
boolean
daysBetween()
function daysBetween(start, end): number;Defined in: date/index.ts:82
Parameters
| Parameter | Type |
|---|---|
start |
string |
end |
string |
Returns
number
effectiveWithin()
function effectiveWithin(range, isoTimestamp): boolean;Defined in: date/index.ts:35
Parameters
| Parameter | Type |
|---|---|
range |
| DateRangeWire | null | undefined |
isoTimestamp |
string |
Returns
boolean
formatDateISO()
function formatDateISO(value): string;Defined in: date/index.ts:23
UTC calendar day YYYY-MM-DD from a stored instant or calendar string.
Parameters
| Parameter | Type |
|---|---|
value |
string | Date |
Returns
string
formatDateRangeLocal()
function formatDateRangeLocal(range, options?): string;Defined in: date/display.ts:18
Format a stored UTC date-range in the viewer's local timezone.
Parameters
| Parameter | Type |
|---|---|
range |
| DateRangeWire | null | undefined |
options |
FormatInstantOptions |
Returns
string
formatUtcInstantLocal()
function formatUtcInstantLocal(value, options?): string;Defined in: date/display.ts:9
Format a stored UTC ISO instant in the viewer's local timezone.
Parameters
| Parameter | Type |
|---|---|
value |
string |
options |
FormatInstantOptions |
Returns
string
hoursFromTimeRange()
function hoursFromTimeRange(timeRange, breakMinutes?): number;Defined in: date/index.ts:69
Hours between same-day time-of-day strings; wraps past midnight when end is before start.
Parameters
| Parameter | Type | Default value |
|---|---|---|
timeRange |
TimeOfDayRange |
undefined |
breakMinutes |
number | null | undefined |
0 |
Returns
number
isUtcIsoInstant()
function isUtcIsoInstant(value): boolean;Defined in: date/wire.ts:18
Parameters
| Parameter | Type |
|---|---|
value |
string |
Returns
boolean
normalizeDateRange()
function normalizeDateRange(range): DateRangeValue;Defined in: date/wire.ts:58
Parameters
| Parameter | Type |
|---|---|
range |
DateRangeValue |
Returns
parseDateRange()
function parseDateRange(range): object;Defined in: date/index.ts:28
Parameters
| Parameter | Type |
|---|---|
range |
DateRangeValue |
Returns
object
end
end: Date;start
start: Date;parseUtcInstant()
function parseUtcInstant(value): Date;Defined in: date/wire.ts:65
Parameters
| Parameter | Type |
|---|---|
value |
string |
Returns
Date
toUtcIsoInstant()
function toUtcIsoInstant(value, boundary): string;Defined in: date/wire.ts:26
Normalize any accepted wire value to a UTC ISO instant string.
Calendar dates (YYYY-MM-DD) map to start/end-of-day in UTC.
Parameters
| Parameter | Type |
|---|---|
value |
string |
boundary |
"start" | "end" |
Returns
string
toUtcIsoTimestamp()
function toUtcIsoTimestamp(value): string;Defined in: date/wire.ts:45
Normalize a timestamptz wire value to UTC ISO (no calendar-day boundary).
Parameters
| Parameter | Type |
|---|---|
value |
string |
Returns
string
utcMonthRange()
function utcMonthRange(year, month): DateRangeValue;Defined in: date/wire.ts:75
Inclusive UTC calendar month as { start, end } UTC ISO instants.
Parameters
| Parameter | Type |
|---|---|
year |
number |
month |
number |
Returns
weekdayForDate()
function weekdayForDate(date): WeekdayName;Defined in: date/index.ts:56
Parameters
| Parameter | Type |
|---|---|
date |
Date |