97 lines
4.3 KiB
TypeScript
97 lines
4.3 KiB
TypeScript
|
import type { LocalizedOptions } from "./types.js";
|
||
|
|
/**
|
||
|
|
* The {@link formatDistance} function options.
|
||
|
|
*/
|
||
|
|
export interface FormatDistanceOptions
|
||
|
|
extends LocalizedOptions<"formatDistance"> {
|
||
|
|
/** Distances less than a minute are more detailed */
|
||
|
|
includeSeconds?: boolean;
|
||
|
|
/** Add "X ago"/"in X" in the locale language */
|
||
|
|
addSuffix?: boolean;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* @name formatDistance
|
||
|
|
* @category Common Helpers
|
||
|
|
* @summary Return the distance between the given dates in words.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Return the distance between the given dates in words.
|
||
|
|
*
|
||
|
|
* | Distance between dates | Result |
|
||
|
|
* |-------------------------------------------------------------------|---------------------|
|
||
|
|
* | 0 ... 30 secs | less than a minute |
|
||
|
|
* | 30 secs ... 1 min 30 secs | 1 minute |
|
||
|
|
* | 1 min 30 secs ... 44 mins 30 secs | [2..44] minutes |
|
||
|
|
* | 44 mins ... 30 secs ... 89 mins 30 secs | about 1 hour |
|
||
|
|
* | 89 mins 30 secs ... 23 hrs 59 mins 30 secs | about [2..24] hours |
|
||
|
|
* | 23 hrs 59 mins 30 secs ... 41 hrs 59 mins 30 secs | 1 day |
|
||
|
|
* | 41 hrs 59 mins 30 secs ... 29 days 23 hrs 59 mins 30 secs | [2..30] days |
|
||
|
|
* | 29 days 23 hrs 59 mins 30 secs ... 44 days 23 hrs 59 mins 30 secs | about 1 month |
|
||
|
|
* | 44 days 23 hrs 59 mins 30 secs ... 59 days 23 hrs 59 mins 30 secs | about 2 months |
|
||
|
|
* | 59 days 23 hrs 59 mins 30 secs ... 1 yr | [2..12] months |
|
||
|
|
* | 1 yr ... 1 yr 3 months | about 1 year |
|
||
|
|
* | 1 yr 3 months ... 1 yr 9 month s | over 1 year |
|
||
|
|
* | 1 yr 9 months ... 2 yrs | almost 2 years |
|
||
|
|
* | N yrs ... N yrs 3 months | about N years |
|
||
|
|
* | N yrs 3 months ... N yrs 9 months | over N years |
|
||
|
|
* | N yrs 9 months ... N+1 yrs | almost N+1 years |
|
||
|
|
*
|
||
|
|
* With `options.includeSeconds == true`:
|
||
|
|
* | Distance between dates | Result |
|
||
|
|
* |------------------------|----------------------|
|
||
|
|
* | 0 secs ... 5 secs | less than 5 seconds |
|
||
|
|
* | 5 secs ... 10 secs | less than 10 seconds |
|
||
|
|
* | 10 secs ... 20 secs | less than 20 seconds |
|
||
|
|
* | 20 secs ... 40 secs | half a minute |
|
||
|
|
* | 40 secs ... 60 secs | less than a minute |
|
||
|
|
* | 60 secs ... 90 secs | 1 minute |
|
||
|
|
*
|
||
|
|
* @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
|
||
|
|
*
|
||
|
|
* @param date - The date
|
||
|
|
* @param baseDate - The date to compare with
|
||
|
|
* @param options - An object with options
|
||
|
|
*
|
||
|
|
* @returns The distance in words
|
||
|
|
*
|
||
|
|
* @throws `date` must not be Invalid Date
|
||
|
|
* @throws `baseDate` must not be Invalid Date
|
||
|
|
* @throws `options.locale` must contain `formatDistance` property
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // What is the distance between 2 July 2014 and 1 January 2015?
|
||
|
|
* const result = formatDistance(new Date(2014, 6, 2), new Date(2015, 0, 1))
|
||
|
|
* //=> '6 months'
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // What is the distance between 1 January 2015 00:00:15
|
||
|
|
* // and 1 January 2015 00:00:00, including seconds?
|
||
|
|
* const result = formatDistance(
|
||
|
|
* new Date(2015, 0, 1, 0, 0, 15),
|
||
|
|
* new Date(2015, 0, 1, 0, 0, 0),
|
||
|
|
* { includeSeconds: true }
|
||
|
|
* )
|
||
|
|
* //=> 'less than 20 seconds'
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // What is the distance from 1 January 2016
|
||
|
|
* // to 1 January 2015, with a suffix?
|
||
|
|
* const result = formatDistance(new Date(2015, 0, 1), new Date(2016, 0, 1), {
|
||
|
|
* addSuffix: true
|
||
|
|
* })
|
||
|
|
* //=> 'about 1 year ago'
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // What is the distance between 1 August 2016 and 1 January 2015 in Esperanto?
|
||
|
|
* import { eoLocale } from 'date-fns/locale/eo'
|
||
|
|
* const result = formatDistance(new Date(2016, 7, 1), new Date(2015, 0, 1), {
|
||
|
|
* locale: eoLocale
|
||
|
|
* })
|
||
|
|
* //=> 'pli ol 1 jaro'
|
||
|
|
*/
|
||
|
|
export declare function formatDistance<DateType extends Date>(
|
||
|
|
date: DateType | number | string,
|
||
|
|
baseDate: DateType | number | string,
|
||
|
|
options?: FormatDistanceOptions,
|
||
|
|
): string;
|