Function.resolveRelativeTimeFormat

@sumup-oss/intl / resolveRelativeTimeFormat

Function: resolveRelativeTimeFormat()

resolveRelativeTimeFormat(locales?, options?): null | ResolvedRelativeTimeFormatOptions

Resolves the locale and collation options that are used to format a relative time.

Parameters

Parameter	Type
locales?	string | string[]
options?	RelativeTimeFormatOptions

Returns

null | ResolvedRelativeTimeFormatOptions

Example

import { resolveRelativeTimeFormat } from '@sumup-oss/intl';

resolveRelativeTimeFormat('de-DE');
// {
//   "locale": "de-DE",
//   "numberingSystem": "latn",
//   "numeric": "always",
//   "style": "long",
// }
resolveRelativeTimeFormat(['pt-BR', 'pt']);
// {
//   "locale": "pt-BR",
//   "numberingSystem": "latn",
//   "numeric": "always",
//   "style": "long",
// }
resolveRelativeTimeFormat('en-GB', {
  style: 'narrow',
});
// {
//   "locale": "en-GB",
//   "numberingSystem": "latn",
//   "numeric": "always",
//   "style": "narrow",
// }

Remarks

In runtimes that don't support the Intl.RelativeTimeFormat.resolvedOptions API, null is returned.

Defined in

lib/relative-time-format/index.ts:171