format

Formats a value and a unit according to the locale and formatting options of the given Intl.RelativeTimeFormat object.

While this method automatically provides the correct plural forms, the grammatical form is otherwise as neutral as possible.

It is the caller's responsibility to handle cut-off logic such as deciding between displaying "in 7 days" or "in 1 week". This API does not support relative dates involving compound units. e.g "in 5 days and 4 hours".

Parameters

value
  • Numeric value to use in the internationalized relative time message

unit
  • Unit to use in the relative time internationalized message.

Throws

RangeError if unit was given something other than unit possible values