microsoft/TypeScript
1
0
Fork 0
mirror of https://github.com/microsoft/TypeScript.git synced 2026-04-13 09:12:52 -05:00
Code Issues Packages Projects Releases 212 Wiki Activity

Implement Intl Locale Info proposal (#60656)

Browse Source 
Co-authored-by: printfn <printfn@users.noreply.github.com>
Co-authored-by: Jake Bailey <5341706+jakebailey@users.noreply.github.com>
This commit is contained in:
printfn
2026-02-07 10:40:58 +13:00
committed by GitHub
parent e018d8ca9e
commit d3ce3cfc38
1 changed files with 78 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
src/lib/esnext.intl.d.ts vendored
View File

@@ -1,3 +1,80 @@
declare namespace Intl {
// Empty
interface Locale {
/**
* Returns a list of one or more unique calendar identifiers for this locale.
*
* [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/getCalendars)
*/
getCalendars(): string[];
/**
* Returns a list of one or more collation types for this locale.
*
* [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/getCollations)
*/
getCollations(): string[];
/**
* Returns a list of one or more unique hour cycle identifiers for this locale.
*
* [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/getHourCycles)
*/
getHourCycles(): string[];
/**
* Returns a list of one or more unique numbering system identifiers for this locale.
*
* [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/getNumberingSystems)
*/
getNumberingSystems(): string[];
/**
* Returns the ordering of characters indicated by either ltr (left-to-right) or by rtl (right-to-left) for this locale.
*
* [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/getTextInfo)
*/
getTextInfo(): TextInfo;
/**
* Returns a list of supported time zones for this locale.
*
* [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/getTimeZones)
*/
getTimeZones(): string[] | undefined;
/**
* Returns a `WeekInfo` object with the properties `firstDay`, `weekend` and `minimalDays` for this locale.
*
* [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/getWeekInfo)
*/
getWeekInfo(): WeekInfo;
}
/**
* An object representing text typesetting information associated with the Locale data specified in UTS 35's Layouts Elements.
*
* [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/getTextInfo#return_value)
*/
interface TextInfo {
/**
* A string indicating the direction of text for the locale. Can be either "ltr" (left-to-right) or "rtl" (right-to-left).
*
* [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/getTextInfo#direction)
*/
direction?: "ltr" | "rtl";
}
/**
* An object representing week information associated with the Locale data specified in UTS 35's Week Elements.
*
* [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/getWeekInfo#return_value)
*/
interface WeekInfo {
/**
* An integer between 1 (Monday) and 7 (Sunday) indicating the first day of the week for the locale. Commonly 1, 5, 6, or 7.
*
* [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/getWeekInfo#firstday)
*/
firstDay: number;
/**
* An array of integers between 1 and 7 indicating the weekend days for the locale.
*
* [MDN Reference](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/getWeekInfo#weekend)
*/
weekend: number[];
}
}