API reference / @localizer/format-relativetime / relativeTimeFormatter

Function: relativeTimeFormatter()

relativeTimeFormatter(options?): RelativeValueFormatter<number | Date>

Defined in: relativeTimeFormatter.ts:30

Generates a function to format relative time strings.

Parameters

Parameter	Type	Description
options?	RelativeTimeFormatOptions	Optional settings for the formatter. Defaults to { numeric: 'auto' }.

Returns

RelativeValueFormatter<number | Date>

A function to format relative time values.