getLargestTimeDurationUnit
Signature
Section titled “Signature”getLargestTimeDurationUnit(units: ("hours" | "minutes" | "seconds" | "milliseconds" | "microseconds" | "nanoseconds" | TimeUnit)[]): "hours" | "minutes" | "seconds" | "milliseconds" | "microseconds" | "nanoseconds" | ""Return the largest TimeDurationUnit from the provided array.
- Returns the largest unit based on Temporal’s unit order: hours > minutes > seconds > milliseconds > microseconds > nanoseconds.
- Each unit may be singular or plural (
"day"or"days"), as Temporal accepts; the result is the plural name. - Returns "" when
unitsis not an array, is empty, or holds anything that is not a unit of this family. - Compatibility: before 1.16.0 an empty or invalid
unitsreturned a default unit ("seconds").
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
units | ("hours" | "minutes" | "seconds" | "milliseconds" | "microseconds" | "nanoseconds" | TimeUnit)[] | array of TimeDurationUnits (singular or plural names) to evaluate |
Returns
Section titled “Returns”the largest TimeDurationUnit found in the array, or "" on invalid input
Related types
Section titled “Related types”Examples
Section titled “Examples”import { getLargestTimeDurationUnit } from "@northguild/gmt/plain/calculate";
getLargestTimeDurationUnit(["minutes", "seconds"]) // "minutes"