Intl.DisplayNames.prototype.resolvedOptions()

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since April 2021.

The resolvedOptions() method of Intl.DisplayNames instances returns a new object with properties reflecting the locale and style formatting options computed during the construction of this Intl.DisplayNames object.

Syntax

js
resolvedOptions()

Parameters

None.

Return value

An object with properties reflecting the locale and formatting options computed during the construction of the given Intl.DisplayNames object.

Description

The object returned by resolvedOptions() has the following properties:

locale

The BCP 47 language tag for the locale actually used. If any Unicode extension values were requested in the input BCP 47 language tag that led to this locale, the key-value pairs that were requested and are supported for this locale are included in locale.

style

The value provided for this property in the options argument of the constructor or the default value ("long"). Its value is either "long", "short", or "narrow".

type

The value provided for this property in the options argument of the constructor or the default value ("language"). Its value is either "language", "region", "script", or "currency".

fallback

The value provided for this property in the options argument of the constructor or the default value ("code"). Its value is either "code" or "none".

Examples

Using resolvedOptions

js
const displayNames = new Intl.DisplayNames(["de-DE"], { type: "region" });

const usedOptions = displayNames.resolvedOptions();
console.log(usedOptions.locale); // "de-DE"
console.log(usedOptions.style); // "long"
console.log(usedOptions.type); // "region"
console.log(usedOptions.fallback); // "code"

Specifications

Specification
ECMAScript Internationalization API Specification
# sec-Intl.DisplayNames.prototype.resolvedOptions

Browser compatibility

BCD tables only load in the browser

See also