parseUnitFromDate
Signature
Section titled “Signature”parseUnitFromDate(value: string, unit: "day" | "year" | "month" | "week" | "dayOfWeek", optionsArg?: { weekStartsOn?: "monday" | "sunday"; }): stringimport { parseUnitFromDate } from "@northguild/gmt/plain/parse";Return a specific date unit extracted from a PlainDate string.
- Extracts “year”, “month”, “day”, “week”, or “dayOfWeek” from a PlainDate.
- Returns zero-padded string for month and day.
- Returns “” for invalid input.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
value |
string |
ISO PlainDate string |
unit |
"day" | "year" | "month" | "week" | "dayOfWeek" |
unit to extract from the date |
Options
Section titled “Options”options
| Option | Type | Default |
|---|---|---|
weekStartsOn? |
"monday" | "sunday" |
— |
Returns
Section titled “Returns”string representation of the requested unit or “” on invalid input
Examples
Section titled “Examples”parseUnitFromDate("2024-03-15", "year") // "2024"parseUnitFromDate("2024-03-15", "month") // "03"parseUnitFromDate("2024-03-15", "day") // "15"parseUnitFromDate("2024-03-15", "week") // "11"parseUnitFromDate("2024-03-15", "dayOfWeek") // "5"parseUnitFromDate("invalid", "year") // ""parseUnitFromDate("2024-01-01", "week", { weekStartsOn: "sunday" }) // "1"