Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

formatDistance

import { formatDistance } from "https://esm.sh/v135/date-fns@3.6.0/index.d.mts";
@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'
function formatDistance<DateType extends Date>(
date: DateType | number | string,
baseDate: DateType | number | string,
): string;
§
formatDistance<DateType extends Date>(date: DateType | number | string, baseDate: DateType | number | string, options?: FormatDistanceOptions): string
[src]

§Type Parameters

§
DateType extends Date
[src]

§Parameters

§
date: DateType | number | string
[src]
  • The date
§
baseDate: DateType | number | string
[src]
  • The date to compare with
§
options?: FormatDistanceOptions optional
[src]
  • An object with options

§Return Type

§
string
[src]

The distance in words