Skip to content

parseUnitFromTime

parseUnitFromTime(value: string, unit: "hour" | "minute" | "second" | "millisecond"): string
import { parseUnitFromTime } from "@northguild/gmt/plain/parse";

Return a specific time unit extracted from a PlainTime string.

  • Extracts “hour”, “minute”, “second”, or “millisecond” from a PlainTime.
  • Returns zero-padded string for hour, minute, second (2 digits) and millisecond (3 digits).
  • Returns “” for invalid input.
Parameter Type Description
value string ISO PlainTime string
unit "hour" | "minute" | "second" | "millisecond" unit to extract from the time

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

parseUnitFromTime("14:30:45.123", "hour") // "14"
parseUnitFromTime("14:30:45.123", "minute") // "30"
parseUnitFromTime("14:30:45.123", "second") // "45"
parseUnitFromTime("14:30:45.123", "millisecond") // "123"
parseUnitFromTime("invalid", "hour") // ""

plain/parse/parseUnitFromTime.ts