UNPKG

@burglekitt/gmt

Version:

Temporal-based date and time utilities with timezone support and polyfill integration

github.com/burglekitt/gmt

burglekitt/gmt

17 lines (16 loc) • 793 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import type { DateDurationUnit } from "../../types/index.js"; /** * 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. * * @param units array of DateDurationUnits to evaluate * @returns the largest DateDurationUnit found in the array, or "days" if none are valid * * @example getLargestDateDurationUnit(["months", "days"]) // "months" * @example getLargestDateDurationUnit(["weeks", "days"]) // "weeks" * @example getLargestDateDurationUnit(["days"]) // "days" * @example getLargestDateDurationUnit([]) // "days" */ export declare function getLargestDateDurationUnit(units: DateDurationUnit[]): DateDurationUnit;