Intl.Segmenter
Baseline 2024
Newly available
Since April 2024, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.
The Intl.Segmenter
object enables locale-sensitive text segmentation, enabling you to get meaningful items (graphemes, words or sentences) from a string.
Try it
Constructor
Intl.Segmenter()
-
Creates a new
Intl.Segmenter
object.
Static methods
Intl.Segmenter.supportedLocalesOf()
-
Returns an array containing those of the provided locales that are supported without having to fall back to the runtime's default locale.
Instance properties
These properties are defined on Intl.Segmenter.prototype
and shared by all Intl.Segmenter
instances.
Intl.Segmenter.prototype.constructor
-
The constructor function that created the instance object. For
Intl.Segmenter
instances, the initial value is theIntl.Segmenter
constructor. Intl.Segmenter.prototype[Symbol.toStringTag]
-
The initial value of the
[Symbol.toStringTag]
property is the string"Intl.Segmenter"
. This property is used inObject.prototype.toString()
.
Instance methods
Intl.Segmenter.prototype.resolvedOptions()
-
Returns a new object with properties reflecting the locale and granularity options computed during initialization of this
Intl.Segmenter
object. Intl.Segmenter.prototype.segment()
-
Returns a new iterable
Segments
instance representing the segments of a string according to the locale and granularity of thisIntl.Segmenter
instance.
Examples
Basic usage and difference from String.prototype.split()
If we were to use String.prototype.split(" ")
to segment a text in words, we would not get the correct result if the locale of the text does not use whitespaces between words (which is the case for Japanese, Chinese, Thai, Lao, Khmer, Myanmar, etc.).
const str = "吾輩は猫である。名前はたぬき。";
console.table(str.split(" "));
// ['吾輩は猫である。名前はたぬき。']
// The two sentences are not correctly segmented.
const str = "吾輩は猫である。名前はたぬき。";
const segmenterJa = new Intl.Segmenter("ja-JP", { granularity: "word" });
const segments = segmenterJa.segment(str);
console.table(Array.from(segments));
// [{segment: '吾輩', index: 0, input: '吾輩は猫である。名前はたぬき。', isWordLike: true},
// etc.
// ]
Specifications
Specification |
---|
ECMAScript Internationalization API Specification # segmenter-objects |
Browser compatibility
BCD tables only load in the browser