MDN self-hosted library · e01.org

Intl.DisplayNames.prototype.of()

The of() method of Intl.DisplayNames instances receives a code and returns a string based on the locale and options provided when instantiating this Intl.DisplayNames object.

no runnable cells javascript-instance-method upstream source

The of() method of Intl.DisplayNames instances receives a code and returns a string based on the locale and options provided when instantiating this Intl.DisplayNames object.

JavaScript Demo: Intl.DisplayNames.prototype.of()

```js interactive-example const regionNamesInEnglish = new Intl.DisplayNames(["en"], { type: "region" }); const regionNamesInTraditionalChinese = new Intl.DisplayNames(["zh-Hant"], { type: "region", });

console.log(regionNamesInEnglish.of("US")); // Expected output: "United States"

console.log(regionNamesInTraditionalChinese.of("US")); // Expected output: "美國"


## Syntax

```js-nolint
of(code)

Parameters

Return value

A language-specific formatted string, or undefined if there's no data for the input and fallback is "none".

[!NOTE] fallback is only used if code is structurally valid. See using fallback.

Exceptions

  • RangeError
  • : Thrown if code is not structurally valid for the given type.

Examples

Using the of method

const regionNames = new Intl.DisplayNames("en", { type: "region" });
regionNames.of("419"); // "Latin America"

const languageNames = new Intl.DisplayNames("en", { type: "language" });
languageNames.of("fr"); // "French"

const currencyNames = new Intl.DisplayNames("en", { type: "currency" });
currencyNames.of("EUR"); // "Euro"

const languageNamesStandard = new Intl.DisplayNames("fr", {
  type: "language",
  languageDisplay: "standard",
});
languageNamesStandard.of("fr-CA"); // "français (Canada)"

const languageNamesDialect = new Intl.DisplayNames("fr", {
  type: "language",
  languageDisplay: "dialect",
});
languageNamesDialect.of("fr-CA"); // "français canadien"

Using fallback

When the Intl.DisplayNames is constructed with fallback: "code", the of() method will return the code if the input looks structurally valid but there's no data for the input. If fallback is "none", undefined is returned.

console.log(
  new Intl.DisplayNames("en", { type: "region", fallback: "code" }).of("ZL"),
); // "ZL"

console.log(
  new Intl.DisplayNames("en", { type: "region", fallback: "none" }).of("ZL"),
); // undefined

However, this only applies if the code is structurally valid. For example, if type is "region" but code does not follow the unicode_region_subtag grammar (2 alphabetic characters or 3 numeric characters), a RangeError is directly thrown instead of using the fallback.

console.log(
  new Intl.DisplayNames("en", { type: "region", fallback: "code" }).of("ZLC"),
); // throws RangeError: invalid value "ZLC" for option region

Specifications

Browser compatibility

See also

  • Intl.DisplayNames