formatTimeAgo

v0.0.15testeddemo

Pure (non-reactive) relative-time formatter. Useful on its own and reused by `useTimeAgo` on every tick.

Example

formatTimeAgo(new Date(Date.now() - 3 * 60_000)); // '3 minutes ago'

Loading demo…

export function formatTimeAgo<UnitNames extends string = UseTimeAgoUnitName>(
  from: Date,
  options: FormatTimeAgoOptions<UnitNames> ={ ... }

UnitNamesextends string= UseTimeAgoUnitName

Parameter	Type	Default	Description
`from`	`Date`	—	The instant to describe
`options`?	`FormatTimeAgoOptions<UnitNames>`	`{}`	Formatting options
`now`?	`number \| Date`	`Date.now()`	The reference "now"

stringThe localized relative-time string