parseYearFromUtc
Signature
Section titled “Signature”parseYearFromUtc(value: string, options?: { timeZone?: string; }): stringReturn the year from a UTC datetime string.
- Returns the year as Temporal writes it: four digits (
"2024","0005"), or a sign and six digits outside 0000–9999 ("+010000","-000005"). - Returns "" for invalid input.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
value | string | ISO UTC datetime string (e.g., “2024-03-17T14:30:45Z”) |
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”the year as four digits, or a sign and six digits outside 0000–9999, or "" on invalid input
Examples
Section titled “Examples”import { parseYearFromUtc } from "@northguild/gmt/utc/parse";
parseYearFromUtc("2024-03-17T14:30:45Z") // "2024"