ui/build/data-renderer/utc-day

Functions

asDayInstant()

function asDayInstant(day): string;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/utc-day.d.ts:4

The canonical stored instant of a UTC calendar day.

Parameters

Parameter	Type
day	string

Returns

string

---

dayToViewerInstant()

function dayToViewerInstant(day, timeZone?): string;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/utc-day.d.ts:6

The viewer-local midnight a calendar should open on for a stored UTC day.

Parameters

Parameter	Type
day	string
timeZone?	string

Returns

string

---

formatUtcDay()

function formatUtcDay(day, locale): string;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/utc-day.d.ts:12

A UTC calendar day in the display locale, independent of the viewer's zone.

Parameters

Parameter	Type
day	string
locale	string

Returns

string

---

toStoredInstant()

function toStoredInstant(value, timeZone?): string | null;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/utc-day.d.ts:14

A picker's emitted viewer-local instant as the canonical stored UTC day.

Parameters

Parameter	Type
value	unknown
timeZone?	string

Returns

string | null

---

toViewerInstant()

function toViewerInstant(value, timeZone?): string | null;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/utc-day.d.ts:10

A stored day-precision instant as the viewer-local midnight a picker should show.

Parameters

Parameter	Type
value	unknown
timeZone?	string

Returns

string | null

---

utcDayOf()

function utcDayOf(value): string | null;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/utc-day.d.ts:2

The UTC calendar day a stored day-precision instant names, or null when it names none.

Parameters

Parameter	Type
value	unknown

Returns

string | null

---

viewerInstantToDay()

function viewerInstantToDay(instant, timeZone?): string | null;

Defined in: apps/website/.api-docs-entry/ui/build/data-renderer/utc-day.d.ts:8

The calendar day a viewer-local instant names, or null when it is not one.

Parameters

Parameter	Type
instant	string
timeZone?	string

Returns

string | null