convertUtcToPlainDate
Signature
Section titled “Signature”convertUtcToPlainDate(value: string, options?: { timeZone?: string; }): stringConvert a UTC datetime string to a plain date string in the format “YYYY-MM-DD”.
- Converts to the
timeZoneoption’s zone before extracting the date. - A year outside 0000–9999 is written with a sign and six digits (
+010000,-000005), as Temporal writes it, so the result is always a stringisValidDateaccepts. - Returns "" for invalid input.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
value | string | UTC datetime string (e.g., “2024-02-29T00:00:00Z”) |
Options
Section titled “Options”options
The time zone the value is read in
| Option | Type | Default | Description |
|---|---|---|---|
timeZone? | string | "UTC" | The time zone the wall-clock fields are read in: an IANA name, a UTC offset (a time zone identifier such as +05:30, +0530 or -08, or a stored offset ±HH:MM[:SS], what getTimeZoneOffset returns), or "local" for the system time zone. An unknown zone returns "". |
Returns
Section titled “Returns”plain date string in “YYYY-MM-DD” format or "" on invalid input
Examples
Section titled “Examples”import { convertUtcToPlainDate } from "@northguild/gmt/utc/convert";
convertUtcToPlainDate("2024-02-29T00:00:00Z") // "2024-02-29"