getRelativeTime

getRelativeTime(
date: string | number | Date,
baseDate: Date,
options: DateFormatOptions,
): string

Source: date.ts:171

Returns a relative time string (e.g., "3 days ago")

Parameters

date (string | number | Date) — Date to compare
baseDate (Date, default: "...") — Base date for comparison (default: now)
options (DateFormatOptions, default: "{}") — Format options

Returns

string — Relative time string

Example

CODE

const yesterday = new Date(Date.now() - 86400000)
getRelativeTime(yesterday) // '1 day ago'

const nextWeek = new Date(Date.now() + 7 * 86400000)
getRelativeTime(nextWeek) // 'in 1 week'