@everwhen/temporal
Version:
_description_
35 lines (34 loc) • 901 B
TypeScript
import type { Point } from '../point.ts';
/**
* Returns the latest (maximum) temporal value from the provided values.
*
* @param values - One or more temporal values of the same type to compare
* @returns The latest temporal value
*
* @example
* ```ts
* import { PlainDate } from '@everwhen/temporal'
* import { max } from '@everwhen/temporal/fn'
*
* const dates = [
* PlainDate.from('2024-03-15'),
* PlainDate.from('2024-01-01'),
* PlainDate.from('2024-06-30'),
* ]
*
* max(...dates) // 2024-06-30
* ```
*
* @example
* ```ts
* import { PlainDateTime } from '@everwhen/temporal'
* import { max } from '@everwhen/temporal/fn'
*
* max(
* PlainDateTime.from('2024-01-01T10:00'),
* PlainDateTime.from('2024-01-01T15:30'),
* PlainDateTime.from('2024-01-01T08:45'),
* ) // 2024-01-01T15:30
* ```
*/
export declare function max<T extends Point>(...values: T[]): T;