| 1 | import type { LocalizedOptions } from "./types.js";
|
| 2 | /**
|
| 3 | * The {@link formatDistance} function options.
|
| 4 | */
|
| 5 | export interface FormatDistanceOptions
|
| 6 | extends LocalizedOptions<"formatDistance"> {
|
| 7 | /** Distances less than a minute are more detailed */
|
| 8 | includeSeconds?: boolean;
|
| 9 | /** Add "X ago"/"in X" in the locale language */
|
| 10 | addSuffix?: boolean;
|
| 11 | }
|
| 12 | /**
|
| 13 | * @name formatDistance
|
| 14 | * @category Common Helpers
|
| 15 | * @summary Return the distance between the given dates in words.
|
| 16 | *
|
| 17 | * @description
|
| 18 | * Return the distance between the given dates in words.
|
| 19 | *
|
| 20 | * | Distance between dates | Result |
|
| 21 | * |-------------------------------------------------------------------|---------------------|
|
| 22 | * | 0 ... 30 secs | less than a minute |
|
| 23 | * | 30 secs ... 1 min 30 secs | 1 minute |
|
| 24 | * | 1 min 30 secs ... 44 mins 30 secs | [2..44] minutes |
|
| 25 | * | 44 mins ... 30 secs ... 89 mins 30 secs | about 1 hour |
|
| 26 | * | 89 mins 30 secs ... 23 hrs 59 mins 30 secs | about [2..24] hours |
|
| 27 | * | 23 hrs 59 mins 30 secs ... 41 hrs 59 mins 30 secs | 1 day |
|
| 28 | * | 41 hrs 59 mins 30 secs ... 29 days 23 hrs 59 mins 30 secs | [2..30] days |
|
| 29 | * | 29 days 23 hrs 59 mins 30 secs ... 44 days 23 hrs 59 mins 30 secs | about 1 month |
|
| 30 | * | 44 days 23 hrs 59 mins 30 secs ... 59 days 23 hrs 59 mins 30 secs | about 2 months |
|
| 31 | * | 59 days 23 hrs 59 mins 30 secs ... 1 yr | [2..12] months |
|
| 32 | * | 1 yr ... 1 yr 3 months | about 1 year |
|
| 33 | * | 1 yr 3 months ... 1 yr 9 month s | over 1 year |
|
| 34 | * | 1 yr 9 months ... 2 yrs | almost 2 years |
|
| 35 | * | N yrs ... N yrs 3 months | about N years |
|
| 36 | * | N yrs 3 months ... N yrs 9 months | over N years |
|
| 37 | * | N yrs 9 months ... N+1 yrs | almost N+1 years |
|
| 38 | *
|
| 39 | * With `options.includeSeconds == true`:
|
| 40 | * | Distance between dates | Result |
|
| 41 | * |------------------------|----------------------|
|
| 42 | * | 0 secs ... 5 secs | less than 5 seconds |
|
| 43 | * | 5 secs ... 10 secs | less than 10 seconds |
|
| 44 | * | 10 secs ... 20 secs | less than 20 seconds |
|
| 45 | * | 20 secs ... 40 secs | half a minute |
|
| 46 | * | 40 secs ... 60 secs | less than a minute |
|
| 47 | * | 60 secs ... 90 secs | 1 minute |
|
| 48 | *
|
| 49 | * @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).
|
| 50 | *
|
| 51 | * @param date - The date
|
| 52 | * @param baseDate - The date to compare with
|
| 53 | * @param options - An object with options
|
| 54 | *
|
| 55 | * @returns The distance in words
|
| 56 | *
|
| 57 | * @throws `date` must not be Invalid Date
|
| 58 | * @throws `baseDate` must not be Invalid Date
|
| 59 | * @throws `options.locale` must contain `formatDistance` property
|
| 60 | *
|
| 61 | * @example
|
| 62 | * // What is the distance between 2 July 2014 and 1 January 2015?
|
| 63 | * const result = formatDistance(new Date(2014, 6, 2), new Date(2015, 0, 1))
|
| 64 | * //=> '6 months'
|
| 65 | *
|
| 66 | * @example
|
| 67 | * // What is the distance between 1 January 2015 00:00:15
|
| 68 | * // and 1 January 2015 00:00:00, including seconds?
|
| 69 | * const result = formatDistance(
|
| 70 | * new Date(2015, 0, 1, 0, 0, 15),
|
| 71 | * new Date(2015, 0, 1, 0, 0, 0),
|
| 72 | * { includeSeconds: true }
|
| 73 | * )
|
| 74 | * //=> 'less than 20 seconds'
|
| 75 | *
|
| 76 | * @example
|
| 77 | * // What is the distance from 1 January 2016
|
| 78 | * // to 1 January 2015, with a suffix?
|
| 79 | * const result = formatDistance(new Date(2015, 0, 1), new Date(2016, 0, 1), {
|
| 80 | * addSuffix: true
|
| 81 | * })
|
| 82 | * //=> 'about 1 year ago'
|
| 83 | *
|
| 84 | * @example
|
| 85 | * // What is the distance between 1 August 2016 and 1 January 2015 in Esperanto?
|
| 86 | * import { eoLocale } from 'date-fns/locale/eo'
|
| 87 | * const result = formatDistance(new Date(2016, 7, 1), new Date(2015, 0, 1), {
|
| 88 | * locale: eoLocale
|
| 89 | * })
|
| 90 | * //=> 'pli ol 1 jaro'
|
| 91 | */
|
| 92 | export declare function formatDistance<DateType extends Date>(
|
| 93 | date: DateType | number | string,
|
| 94 | baseDate: DateType | number | string,
|
| 95 | options?: FormatDistanceOptions,
|
| 96 | ): string;
|