Skip to main content
Deno 2 is finally here 🎉️
Learn more
Go to Latest
function formatDistance
import { formatDistance } from "https://deno.land/x/date_fns@v2.12.0/index.js";

Examples

// What is the distance between 2 July 2014 and 1 January 2015? var result = formatDistance(new Date(2014, 6, 2), new Date(2015, 0, 1)) //=> '6 months'

// What is the distance between 1 January 2015 00:00:15 // and 1 January 2015 00:00:00, including seconds? var result = formatDistance( new Date(2015, 0, 1, 0, 0, 15), new Date(2015, 0, 1, 0, 0, 0), { includeSeconds: true } ) //=> 'less than 20 seconds'

// What is the distance from 1 January 2016 // to 1 January 2015, with a suffix? var result = formatDistance(new Date(2015, 0, 1), new Date(2016, 0, 1), { addSuffix: true }) //=> 'about 1 year ago'

// What is the distance between 1 August 2016 and 1 January 2015 in Esperanto? import { eoLocale } from 'date-fns/locale/eo' var result = formatDistance(new Date(2016, 7, 1), new Date(2015, 0, 1), { locale: eoLocale }) //=> 'pli ol 1 jaro'

Parameters

dirtyDate
  • the date
dirtyBaseDate
  • the date to compare with
dirtyOptions