Skip to content

getLargestTimeDurationUnit

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

Return the largest TimeDurationUnit from the provided array.

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

the largest TimeDurationUnit found in the array, or “seconds” if none are valid

getLargestTimeDurationUnit(["minutes", "seconds"]) // "minutes"
getLargestTimeDurationUnit(["seconds", "milliseconds"]) // "seconds"
getLargestTimeDurationUnit(["milliseconds", "microseconds"]) // "milliseconds"
getLargestTimeDurationUnit([]) // "seconds"

plain/calculate/getLargestTimeDurationUnit.ts