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) • 891 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import type { TimeDurationUnit } from "../../types/index.js"; /** * 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. * * @param units array of TimeDurationUnits to evaluate * @returns the largest TimeDurationUnit found in the array, or "seconds" if none are valid * * @example getLargestTimeDurationUnit(["minutes", "seconds"]) // "minutes" * @example getLargestTimeDurationUnit(["seconds", "milliseconds"]) // "seconds" * @example getLargestTimeDurationUnit(["milliseconds", "microseconds"]) // "milliseconds" * @example getLargestTimeDurationUnit([]) // "seconds" */ export declare function getLargestTimeDurationUnit(units: TimeDurationUnit[]): TimeDurationUnit;