FormatTimeAgoOptions

testeddemo

Options shared by the pure `formatTimeAgo` and the reactive `useTimeAgo`.

Demo

Loading demo…

interface FormatTimeAgoOptions<UnitNames extends string = UseTimeAgoUnitName>

UnitNamesextends string= UseTimeAgoUnitName

Property	Type	Default	Description
`max`?	`number \| UnitNames \| undefined`	—	Maximum unit (or absolute ms diff) to display before falling back to `fullDateFormatter`.
`fullDateFormatter`?	`((date: Date) => string) \| undefined`	`(date) => date.toISOString().slice(0, 10)`	Formatter applied when the diff exceeds `max`.
`messages`?	`UseTimeAgoMessages<UnitNames> \| undefined`	—	Localized messages.
`showSecond`?	`boolean \| undefined`	`false`	Show seconds (i.e. allow sub-minute granularity) instead of `justNow`.
`rounding`?	`number \| "round" \| "ceil" \| "floor" \| undefined`	`'round'`	Rounding strategy applied to unit values. A string maps to the matching `Math` method; a number rounds to that many decimal places.
`units`?	`UseTimeAgoUnit<UnitNames>[] \| undefined`	—	Custom ordered list of units (ascending by `value`).