Skip to content

Commit 4a0b083

Browse files
petamorikenpetamoriken
authored
Add ES2022 Intl.Segmenter type (#48800)
* Add `Intl.Segmenter` type * Update baseline * Fix useless generics * Fix indent size * Fix `ResolvedSegmenterOptions`
1 parent 58114cf commit 4a0b083

13 files changed

+106
-8
lines changed

‎src/compiler/commandLineParser.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ namespace ts {
8181
["es2021.intl", "lib.es2021.intl.d.ts"],
8282
["es2022.array", "lib.es2022.array.d.ts"],
8383
["es2022.error", "lib.es2022.error.d.ts"],
84+
["es2022.intl", "lib.es2022.intl.d.ts"],
8485
["es2022.object", "lib.es2022.object.d.ts"],
8586
["es2022.string", "lib.es2022.string.d.ts"],
8687
["esnext.array", "lib.es2022.array.d.ts"],

‎src/lib/es2022.d.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
/// <reference lib="es2021" />
22
/// <reference lib="es2022.array" />
33
/// <reference lib="es2022.error" />
4+
/// <reference lib="es2022.intl" />
45
/// <reference lib="es2022.object" />
56
/// <reference lib="es2022.string" />

‎src/lib/es2022.intl.d.ts‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
declare namespace Intl {
2+
3+
/**
4+
* An object with some or all properties of the `Intl.Segmenter` constructor `options` parameter.
5+
*
6+
* [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Segmenter/Segmenter#parameters)
7+
*/
8+
interface SegmenterOptions {
9+
/** The locale matching algorithm to use. For information about this option, see [Intl page](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Intl#Locale_negotiation). */
10+
localeMatcher?: "best fit" | "lookup" | undefined;
11+
/** The type of input to be split */
12+
granularity?: "grapheme" | "word" | "sentence" | undefined;
13+
}
14+
15+
interface Segmenter {
16+
/**
17+
* Returns `Segments` object containing the segments of the input string, using the segmenter's locale and granularity.
18+
*
19+
* @param input - The text to be segmented as a `string`.
20+
*
21+
* @returns A new iterable Segments object containing the segments of the input string, using the segmenter's locale and granularity.
22+
*/
23+
segment(input: string): Segments;
24+
resolvedOptions(): ResolvedSegmenterOptions;
25+
}
26+
27+
interface ResolvedSegmenterOptions {
28+
locale: string;
29+
granularity: "grapheme" | "word" | "sentence";
30+
}
31+
32+
interface Segments {
33+
/**
34+
* Returns an object describing the segment in the original string that includes the code unit at a specified index.
35+
*
36+
* @param codeUnitIndex - A number specifying the index of the code unit in the original input string. If the value is omitted, it defaults to `0`.
37+
*/
38+
containing(codeUnitIndex?: number): SegmentData;
39+
40+
/** Returns an iterator to iterate over the segments. */
41+
[Symbol.iterator](): IterableIterator<SegmentData>;
42+
}
43+
44+
interface SegmentData {
45+
/** A string containing the segment extracted from the original input string. */
46+
segment: string;
47+
/** The code unit index in the original input string at which the segment begins. */
48+
index: number;
49+
/** The complete input string that was segmented. */
50+
input: string;
51+
/**
52+
* A boolean value only if granularity is "word"; otherwise, undefined.
53+
* If granularity is "word", then isWordLike is true when the segment is word-like (i.e., consists of letters/numbers/ideographs/etc.); otherwise, false.
54+
*/
55+
isWordLike?: boolean;
56+
}
57+
58+
const Segmenter: {
59+
prototype: Segmenter;
60+
61+
/**
62+
* Creates a new `Intl.Segmenter` object.
63+
*
64+
* @param locales - A string with a [BCP 47 language tag](http://tools.ietf.org/html/rfc5646), or an array of such strings.
65+
* For the general form and interpretation of the `locales` argument,
66+
* see the [`Intl` page](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#Locale_identification_and_negotiation).
67+
*
68+
* @param options - An [object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Segmenter/Segmenter#parameters)
69+
* with some or all options of `SegmenterOptions`.
70+
*
71+
* @returns [Intl.Segmenter](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Segments) object.
72+
*
73+
* [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Segmenter).
74+
*/
75+
new(locales?: BCP47LanguageTag | BCP47LanguageTag[], options?: SegmenterOptions): Segmenter;
76+
77+
/**
78+
* Returns an array containing those of the provided locales that are supported without having to fall back to the runtime's default locale.
79+
*
80+
* @param locales - A string with a [BCP 47 language tag](http://tools.ietf.org/html/rfc5646), or an array of such strings.
81+
* For the general form and interpretation of the `locales` argument,
82+
* see the [`Intl` page](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#Locale_identification_and_negotiation).
83+
*
84+
* @param options An [object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Segmenter/supportedLocalesOf#parameters).
85+
* with some or all possible options.
86+
*
87+
* [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Segmenter/supportedLocalesOf)
88+
*/
89+
supportedLocalesOf(locales: BCP47LanguageTag | BCP47LanguageTag[], options?: Pick<SegmenterOptions, "localeMatcher">): BCP47LanguageTag[];
90+
};
91+
}

‎src/lib/libs.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@
5757
"es2021.intl",
5858
"es2022.array",
5959
"es2022.error",
60+
"es2022.intl",
6061
"es2022.object",
6162
"es2022.string",
6263
"esnext.intl",

‎tests/baselines/reference/es2022IntlAPIs.symbols‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ for (const zoneName of timezoneNames) {
1111
var formatter = new Intl.DateTimeFormat('en-US', {
1212
>formatter : Symbol(formatter, Decl(es2022IntlAPIs.ts, 3, 5))
1313
>Intl.DateTimeFormat : Symbol(Intl.DateTimeFormat, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es2017.intl.d.ts, --, --), Decl(lib.es2021.intl.d.ts, --, --))
14-
>Intl : Symbol(Intl, Decl(lib.es5.d.ts, --, --), Decl(lib.es2017.intl.d.ts, --, --), Decl(lib.es2018.intl.d.ts, --, --), Decl(lib.es2020.bigint.d.ts, --, --), Decl(lib.es2020.intl.d.ts, --, --) ... and 1 more)
14+
>Intl : Symbol(Intl, Decl(lib.es5.d.ts, --, --), Decl(lib.es2017.intl.d.ts, --, --), Decl(lib.es2018.intl.d.ts, --, --), Decl(lib.es2020.bigint.d.ts, --, --), Decl(lib.es2020.intl.d.ts, --, --) ... and 2 more)
1515
>DateTimeFormat : Symbol(Intl.DateTimeFormat, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es2017.intl.d.ts, --, --), Decl(lib.es2021.intl.d.ts, --, --))
1616

1717
timeZone: 'America/Los_Angeles',

‎tests/baselines/reference/formatToPartsBigInt.symbols‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
new Intl.NumberFormat("fr").formatToParts(3000n);
66
>new Intl.NumberFormat("fr").formatToParts : Symbol(Intl.NumberFormat.formatToParts, Decl(lib.es2018.intl.d.ts, --, --))
77
>Intl.NumberFormat : Symbol(Intl.NumberFormat, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es2018.intl.d.ts, --, --), Decl(lib.es2020.bigint.d.ts, --, --), Decl(lib.esnext.intl.d.ts, --, --))
8-
>Intl : Symbol(Intl, Decl(lib.es5.d.ts, --, --), Decl(lib.es2017.intl.d.ts, --, --), Decl(lib.es2018.intl.d.ts, --, --), Decl(lib.es2020.bigint.d.ts, --, --), Decl(lib.es2020.intl.d.ts, --, --) ... and 2 more)
8+
>Intl : Symbol(Intl, Decl(lib.es5.d.ts, --, --), Decl(lib.es2017.intl.d.ts, --, --), Decl(lib.es2018.intl.d.ts, --, --), Decl(lib.es2020.bigint.d.ts, --, --), Decl(lib.es2020.intl.d.ts, --, --) ... and 3 more)
99
>NumberFormat : Symbol(Intl.NumberFormat, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es2018.intl.d.ts, --, --), Decl(lib.es2020.bigint.d.ts, --, --), Decl(lib.esnext.intl.d.ts, --, --))
1010
>formatToParts : Symbol(Intl.NumberFormat.formatToParts, Decl(lib.es2018.intl.d.ts, --, --))
1111

1212
new Intl.NumberFormat("fr").formatToParts(BigInt(123));
1313
>new Intl.NumberFormat("fr").formatToParts : Symbol(Intl.NumberFormat.formatToParts, Decl(lib.es2018.intl.d.ts, --, --))
1414
>Intl.NumberFormat : Symbol(Intl.NumberFormat, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es2018.intl.d.ts, --, --), Decl(lib.es2020.bigint.d.ts, --, --), Decl(lib.esnext.intl.d.ts, --, --))
15-
>Intl : Symbol(Intl, Decl(lib.es5.d.ts, --, --), Decl(lib.es2017.intl.d.ts, --, --), Decl(lib.es2018.intl.d.ts, --, --), Decl(lib.es2020.bigint.d.ts, --, --), Decl(lib.es2020.intl.d.ts, --, --) ... and 2 more)
15+
>Intl : Symbol(Intl, Decl(lib.es5.d.ts, --, --), Decl(lib.es2017.intl.d.ts, --, --), Decl(lib.es2018.intl.d.ts, --, --), Decl(lib.es2020.bigint.d.ts, --, --), Decl(lib.es2020.intl.d.ts, --, --) ... and 3 more)
1616
>NumberFormat : Symbol(Intl.NumberFormat, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es2018.intl.d.ts, --, --), Decl(lib.es2020.bigint.d.ts, --, --), Decl(lib.esnext.intl.d.ts, --, --))
1717
>formatToParts : Symbol(Intl.NumberFormat.formatToParts, Decl(lib.es2018.intl.d.ts, --, --))
1818
>BigInt : Symbol(BigInt, Decl(lib.es2020.bigint.d.ts, --, --), Decl(lib.es2020.bigint.d.ts, --, --))

‎tests/baselines/reference/numberFormatCurrencySign.symbols‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ const str = new Intl.NumberFormat('en-NZ', { style: 'currency', currency: 'NZD',
33
>str : Symbol(str, Decl(numberFormatCurrencySign.ts, 0, 5))
44
>new Intl.NumberFormat('en-NZ', { style: 'currency', currency: 'NZD', currencySign: 'accounting' }).format : Symbol(Intl.NumberFormat.format, Decl(lib.es5.d.ts, --, --), Decl(lib.es2020.bigint.d.ts, --, --))
55
>Intl.NumberFormat : Symbol(Intl.NumberFormat, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es2018.intl.d.ts, --, --), Decl(lib.es2020.bigint.d.ts, --, --), Decl(lib.esnext.intl.d.ts, --, --))
6-
>Intl : Symbol(Intl, Decl(lib.es5.d.ts, --, --), Decl(lib.es2017.intl.d.ts, --, --), Decl(lib.es2018.intl.d.ts, --, --), Decl(lib.es2020.bigint.d.ts, --, --), Decl(lib.es2020.intl.d.ts, --, --) ... and 2 more)
6+
>Intl : Symbol(Intl, Decl(lib.es5.d.ts, --, --), Decl(lib.es2017.intl.d.ts, --, --), Decl(lib.es2018.intl.d.ts, --, --), Decl(lib.es2020.bigint.d.ts, --, --), Decl(lib.es2020.intl.d.ts, --, --) ... and 3 more)
77
>NumberFormat : Symbol(Intl.NumberFormat, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es2018.intl.d.ts, --, --), Decl(lib.es2020.bigint.d.ts, --, --), Decl(lib.esnext.intl.d.ts, --, --))
88
>style : Symbol(style, Decl(numberFormatCurrencySign.ts, 0, 44))
99
>currency : Symbol(currency, Decl(numberFormatCurrencySign.ts, 0, 63))

‎tests/baselines/reference/numberFormatCurrencySignResolved.symbols‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ const options = new Intl.NumberFormat('en-NZ', { style: 'currency', currency: 'N
33
>options : Symbol(options, Decl(numberFormatCurrencySignResolved.ts, 0, 5))
44
>new Intl.NumberFormat('en-NZ', { style: 'currency', currency: 'NZD', currencySign: 'accounting' }).resolvedOptions : Symbol(Intl.NumberFormat.resolvedOptions, Decl(lib.es5.d.ts, --, --), Decl(lib.es2020.bigint.d.ts, --, --))
55
>Intl.NumberFormat : Symbol(Intl.NumberFormat, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es2018.intl.d.ts, --, --), Decl(lib.es2020.bigint.d.ts, --, --), Decl(lib.esnext.intl.d.ts, --, --))
6-
>Intl : Symbol(Intl, Decl(lib.es5.d.ts, --, --), Decl(lib.es2017.intl.d.ts, --, --), Decl(lib.es2018.intl.d.ts, --, --), Decl(lib.es2020.bigint.d.ts, --, --), Decl(lib.es2020.intl.d.ts, --, --) ... and 2 more)
6+
>Intl : Symbol(Intl, Decl(lib.es5.d.ts, --, --), Decl(lib.es2017.intl.d.ts, --, --), Decl(lib.es2018.intl.d.ts, --, --), Decl(lib.es2020.bigint.d.ts, --, --), Decl(lib.es2020.intl.d.ts, --, --) ... and 3 more)
77
>NumberFormat : Symbol(Intl.NumberFormat, Decl(lib.es5.d.ts, --, --), Decl(lib.es5.d.ts, --, --), Decl(lib.es2018.intl.d.ts, --, --), Decl(lib.es2020.bigint.d.ts, --, --), Decl(lib.esnext.intl.d.ts, --, --))
88
>style : Symbol(style, Decl(numberFormatCurrencySignResolved.ts, 0, 48))
99
>currency : Symbol(currency, Decl(numberFormatCurrencySignResolved.ts, 0, 67))

‎tests/baselines/reference/reactJsxReactResolvedNodeNext.trace.json‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,5 +145,7 @@
145145
"File 'package.json' does not exist according to earlier cached lookups.",
146146
"File '/package.json' does not exist according to earlier cached lookups.",
147147
"File 'package.json' does not exist according to earlier cached lookups.",
148+
"File '/package.json' does not exist according to earlier cached lookups.",
149+
"File 'package.json' does not exist according to earlier cached lookups.",
148150
"File '/package.json' does not exist according to earlier cached lookups."
149151
]

‎tests/baselines/reference/reactJsxReactResolvedNodeNextEsm.trace.json‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,5 +139,7 @@
139139
"File 'package.json' does not exist according to earlier cached lookups.",
140140
"File '/package.json' does not exist according to earlier cached lookups.",
141141
"File 'package.json' does not exist according to earlier cached lookups.",
142+
"File '/package.json' does not exist according to earlier cached lookups.",
143+
"File 'package.json' does not exist according to earlier cached lookups.",
142144
"File '/package.json' does not exist according to earlier cached lookups."
143145
]

0 commit comments

Comments
 (0)