getLargestDateDurationUnit
Signature
Section titled “Signature”getLargestDateDurationUnit(units: DateDurationUnit[]): DateDurationUnitimport { getLargestDateDurationUnit } from "@northguild/gmt/plain/calculate";Return the largest DateDurationUnit from the provided array.
- Returns the largest unit based on Temporal’s unit order: years > months > weeks > days.
- Defaults to “days” if no valid unit is found in the array.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
units |
DateDurationUnit[] |
array of DateDurationUnits to evaluate |
Returns
Section titled “Returns”the largest DateDurationUnit found in the array, or “days” if none are valid
Related types
Section titled “Related types”Examples
Section titled “Examples”getLargestDateDurationUnit(["months", "days"]) // "months"getLargestDateDurationUnit(["weeks", "days"]) // "weeks"getLargestDateDurationUnit(["days"]) // "days"getLargestDateDurationUnit([]) // "days"