parseYearFromUnix

Signature

parseYearFromUnix(value: string | number, options?: { epochUnit?: UnixUnit; timeZone?: string; }): string

Return the year from a unix epoch value.

• Delegates to {@link parseUnitFromUnix} with unit “year”.
• value is a safe integer or a digit string.
• Returns "" for invalid input.
• The year is written as Temporal writes it: four digits ("2024", "0005"), or a sign and six digits outside 0000–9999 ("+010000", "-000005").

Parameters

Parameter	Type	Description
value	string | number	unix epoch in milliseconds or seconds: a safe integer, or a string of optionally negative ASCII digits

Options

options

optional: how value is read and the zone its wall clock is read in

Option	Type	Default	Description
epochUnit?	"seconds" | "milliseconds" | "second" | "millisecond" (UnixUnit)	"milliseconds"	The unit the epoch values are counted in: "seconds" or "milliseconds", singular or plural. Any other value returns "".
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

the year as four digits, or a sign and six digits outside 0000–9999, or "" on invalid input

Related types

• UnixUnit

Examples

import { parseYearFromUnix } from "@northguild/gmt/unix/parse";

parseYearFromUnix(1700000000000) // "2023"

value

output

 

Source

unix/parse/parseYearFromUnix.ts