Skip to content

getLargestDateTimeDurationUnit

getLargestDateTimeDurationUnit(units: DateTimeDurationUnit[]): DateTimeDurationUnit
import { getLargestDateTimeDurationUnit } from "@northguild/gmt/plain/calculate";

Return the largest DateTimeDurationUnit from the provided array.

  • Returns the largest unit based on Temporal’s unit order: years > months > weeks > days > hours > minutes > seconds > milliseconds > microseconds > nanoseconds.
  • Defaults to “seconds” if no valid unit is found in the array.
Parameter Type Description
units DateTimeDurationUnit[] array of DateTimeDurationUnit to evaluate

the largest DateTimeDurationUnit found, or “seconds” if none are valid

getLargestDateTimeDurationUnit(["hours", "minutes", "seconds"]) // "hours"
getLargestDateTimeDurationUnit(["minutes", "seconds"]) // "minutes"
getLargestDateTimeDurationUnit(["seconds"]) // "seconds"
getLargestDateTimeDurationUnit([]) // "seconds"

plain/calculate/getLargestDateTimeDurationUnit.ts