Intl.Segmenter.prototype.resolvedOptions()

The Intl.Segmenter.prototype.resolvedOptions() method returns a new object with properties reflecting the locale and granularity options computed during the initialization of this Intl.Segmenter object.

Try it

Syntax

resolvedOptions()

Parameters

None.

Return value

A new object with properties reflecting the locale and collation options computed during the initialization of the given Intl.Segmenter object.

Description

The resulting object 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.

granularity

The value provided for this property in the options argument or filled in as the default.

Examples

Basic usage

const spanishSegmenter = new Intl.Segmenter("es", {granularity: "sentence"});
const options = spanishSegmenter.resolvedOptions();
console.log(options.locale); // "es"
console.log(options.granularity); // "sentence"

Default granularity

const spanishSegmenter = new Intl.Segmenter("es");
const options = spanishSegmenter.resolvedOptions();
console.log(options.locale); // "es"
console.log(options.granularity); // "grapheme"

Fallback locale

const banSegmenter = new Intl.Segmenter("ban");
const options = banSegmenter.resolvedOptions();
console.log(options.locale);
// "fr" on a runtime where the Balinese locale
// is not supported and French is the default locale
console.log(options.granularity); // "grapheme"

Specifications

Specification
ECMAScript Internationalization API Specification
# sec-intl.segmenter.prototype.resolvedoptions

Browser compatibility

BCD tables only load in the browser