parseUnitFromDateTime

Signature

parseUnitFromDateTime(value: string, unit: "day" | "hour" | "year" | "month" | "week" | "minute" | "second" | "dayOfWeek" | "millisecond", optionsArg?: { weekStartsOn?: "monday" | "sunday"; }): string

import { parseUnitFromDateTime } from "@northguild/gmt/plain/parse";

Return a specific unit extracted from a PlainDateTime string.

• Extracts “year”, “month”, “day”, “week”, “dayOfWeek”, “hour”, “minute”, “second”, or “millisecond” from a PlainDateTime.
• Returns zero-padded string for most units.
• Returns “” for invalid input.

Parameters

Parameter	Type	Description
value	string	ISO PlainDateTime string
unit	"day" | "hour" | "year" | "month" | "week" | "minute" | "second" | "dayOfWeek" | "millisecond"	unit to extract from the datetime

Options

options

Option	Type	Default
weekStartsOn?	"monday" | "sunday"	—

Returns

string representation of the requested unit or “” on invalid input

Examples

parseUnitFromDateTime("2024-03-15T14:30:45.123", "year") // "2024"
parseUnitFromDateTime("2024-03-15T14:30:45.123", "week") // "11"
parseUnitFromDateTime("2024-03-15T14:30:45.123", "hour") // "14"
parseUnitFromDateTime("2024-03-15T14:30:45.123", "millisecond") // "123"
parseUnitFromDateTime("invalid", "year") // ""
parseUnitFromDateTime("2024-01-01T00:00:00", "week", { weekStartsOn: "sunday" }) // "1"

Source

plain/parse/parseUnitFromDateTime.ts