Intl.Segmenter.prototype.segment()
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since April 2024.
The segment() method of Intl.Segmenter instances segments a string according to the locale and granularity of this Intl.Segmenter object.
Try it
const string1 = "Que ma joie demeure";
const segmenterFrGrapheme = new Intl.Segmenter("fr", {
granularity: "grapheme",
});
const graphemeSegments = segmenterFrGrapheme.segment(string1);
console.log(Array.from(graphemeSegments)[0]);
// Expected output:
// Object {segment: 'Q', index: 0, input: 'Que ma joie demeure'}
Syntax
js
segment(input)
Parameters
input-
The text to be segmented as a string.
Return value
A new iterable Segments object containing the segments of the input string, using the segmenter's locale and granularity.
Examples
js
// Create a locale-specific word segmenter
const segmenter = new Intl.Segmenter("fr", { granularity: "word" });
// Use it to get an iterator over the segments of a string
const input = "Moi ? N'est-ce pas ?";
const segments = segmenter.segment(input);
// Use that for segmentation
for (const { segment, index, isWordLike } of segments) {
console.log(
"segment at code units [%d, %d]: «%s»%s",
index,
index + segment.length,
segment,
isWordLike ? " (word-like)" : "",
);
}
// segment at code units [0, 3]: «Moi» (word-like)
// segment at code units [3, 4]: « »
// segment at code units [4, 5]: «?»
// segment at code units [5, 6]: « »
// segment at code units [6, 11]: «N'est» (word-like)
// segment at code units [11, 12]: «-»
// segment at code units [12, 14]: «ce» (word-like)
// segment at code units [14, 15]: « »
// segment at code units [15, 18]: «pas» (word-like)
// segment at code units [18, 19]: « »
// segment at code units [19, 20]: «?»
Specifications
| Specification |
|---|
| ECMAScript® 2027 Internationalization API Specification # sec-intl.segmenter.prototype.segment |