convertUtcToZoned
Signature
Section titled “Signature”convertUtcToZoned(value: string, timeZone: string): stringConvert a UTC Instant string to a zoned ISO 8601 datetime string.
- Uses Temporal.Instant.from to parse, converts to specified timezone.
- Validates both UTC input and timezone.
- Returns "" for invalid input.
- An offset with seconds (
-00:44:30) returns"". A written zone cannot carry seconds (RFC 9557 §4.1), so the result could not name it. Pass the IANA name, or callfromOffsetInstant({ instant, offset })for the local time with its full offset and no bracket.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
value | string | UTC Instant string |
timeZone | string | IANA name or a UTC offset to the minute (what isValidTimeZone accepts) |
Returns
Section titled “Returns”zoned ISO 8601 string or "" on invalid
Examples
Section titled “Examples”import { convertUtcToZoned } from "@northguild/gmt/utc/convert";
convertUtcToZoned("2024-02-29T00:00:00Z", "America/New_York") // "2024-02-28T19:00:00-05:00[America/New_York]"