getUnixNowUnit
Signature
Section titled “Signature”getUnixNowUnit(unit: PluralUnit<DateTimeUnit> | UnixNowUnit): stringReturn the requested unit value from the current Unix timestamp in UTC.
- Valid units: “year”, “month”, “week”, “day”, “dayOfWeek”, “hour”, “minute”, “second”, “millisecond”, “microsecond”, “nanosecond”. Temporal units may also be plural (“hours”).
microsecondandnanosecondare Temporal’s 0–999 fields, zero-padded to 3 digits.- Uses Temporal.Now.instant() converted to UTC zoned date time.
- Returns "" on invalid unit or failure.
- The
"year"unit is written as Temporal writes a year: four digits ("2024","0005"), or a sign and six digits outside 0000–9999 ("+010000","-000005").
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
unit | PluralUnit<DateTimeUnit> | UnixNowUnit | unit to extract from current unix timestamp |
Returns
Section titled “Returns”string representation of the requested unit or "" on invalid
UnixNowUnit
Section titled “UnixNowUnit”Units extractable from the current Unix timestamp in UTC via getUnixNowUnit. Defined as DateTimeUnit | "dayOfWeek".
import type { UnixNowUnit } from "@northguild/gmt";DateTimeUnit | "dayOfWeek"Examples
Section titled “Examples”import { getUnixNowUnit } from "@northguild/gmt/unix/get";
getUnixNowUnit("year") // "2024"