@@ -9,7 +9,7 @@ APIs are provided to access the system language and region information.
...
@@ -9,7 +9,7 @@ APIs are provided to access the system language and region information.
### Available APIs
### Available APIs
| Module | API | Description |
| Module | API | Description |
| -------- | -------- | -------- |
| -------- | -------- | -------- |
| ohos.i18n | getSystemLanguage(): string | Obtains the system language. |
| ohos.i18n | getSystemLanguage(): string | Obtains the system language. |
| ohos.i18n | getSystemRegion(): string | Obtains the system region. |
| ohos.i18n | getSystemRegion(): string | Obtains the system region. |
...
@@ -22,7 +22,7 @@ APIs are provided to access the system language and region information.
...
@@ -22,7 +22,7 @@ APIs are provided to access the system language and region information.
### How to Develop
### How to Develop
1. Obtain the system language.
1. Obtain the system language.<br>
Call the **getSystemLanguage** method to obtain the system language (**i18n** is the name of the imported module).
Call the **getSystemLanguage** method to obtain the system language (**i18n** is the name of the imported module).
...
@@ -30,21 +30,21 @@ APIs are provided to access the system language and region information.
...
@@ -30,21 +30,21 @@ APIs are provided to access the system language and region information.
var language = i18n.getSystemLanguage();
var language = i18n.getSystemLanguage();
```
```
2. Obtains the system region.
2. Obtain the system region.<br>
Call the **getSystemRegion** method to obtain the system region.
Call the **getSystemRegion** method to obtain the system region.
```
```
var region = i18n.getSystemRegion();
var region = i18n.getSystemRegion();
```
```
3. Obtain the system locale.
3. Obtain the system locale.<br>
Call the **getSystemLocale** method to obtain the system locale.
Call the **getSystemLocale** method to obtain the system locale.
```
```
var locale = i18n.getSystemLocale();
var locale = i18n.getSystemLocale();
```
```
4. Check whether the locale's language is RTL.
4. Check whether the locale's language is RTL.<br>
Call the **isRTL** method to check whether the locale's language is RTL.
Call the **isRTL** method to check whether the locale's language is RTL.
...
@@ -52,15 +52,15 @@ APIs are provided to access the system language and region information.
...
@@ -52,15 +52,15 @@ APIs are provided to access the system language and region information.
var rtl = i18n.isRTL("zh-CN");
var rtl = i18n.isRTL("zh-CN");
```
```
5. Check whether the system uses a 24-hour clock.
5. Check whether the system uses a 24-hour clock.<br>
Call the **is24HourClock** method to check whether the system uses a 24-hour clock.
Call the **is24HourClock** method to check whether the system uses a 24-hour clock.
```
```
var hourClock = i18n.is24HourClock();
var hourClock = i18n.is24HourClock();
```
```
6. Obtain the localized display of a language.
6. Obtain the localized display of a language.<br>
Call the **getDisplayLanguage** method to obtain the localized display of a language. **language** indicates the language to be localized, **locale** indicates the locale, and **sentenceCase** indicates whether the first letter of the result must be capitalized.
Call the **getDisplayLanguage** method to obtain the localized display of a language. **language** indicates the language to be localized, **locale** indicates the locale, and **sentenceCase** indicates whether the first letter of the result must be capitalized.
```
```
var language = "en";
var language = "en";
...
@@ -69,8 +69,8 @@ APIs are provided to access the system language and region information.
...
@@ -69,8 +69,8 @@ APIs are provided to access the system language and region information.
var localizedLanguage = i18n.getDisplayLanguage(language, locale, sentenceCase);
var localizedLanguage = i18n.getDisplayLanguage(language, locale, sentenceCase);
```
```
7. Obtain the localized display of a country.
7. Obtain the localized display of a country.<br>
Call the **getDisplayCountry** method to obtain the localized display of a country. **country** indicates the country to be localized, **locale** indicates the locale, and **sentenceCase** indicates whether the first letter of the result must be capitalized.
Call the **getDisplayCountry** method to obtain the localized display of a country. **country** indicates the country to be localized, **locale** indicates the locale, and **sentenceCase** indicates whether the first letter of the result must be capitalized.
```
```
var country = "US";
var country = "US";
...
@@ -105,7 +105,7 @@ APIs are provided to access the system language and region information.
...
@@ -105,7 +105,7 @@ APIs are provided to access the system language and region information.
### How to Develop
### How to Develop
1. Instantiate a **Calendar** object.
1. Instantiate a **Calendar** object.<br>
Call the **getCalendar** method to obtain the time zone object of a specific locale and type (**i18n** is the name of the imported module). **type** indicates the valid calendar type, for example, **buddhist**, **chinese**, **coptic**, **ethiopic**, **hebrew**, **gregory**, **indian**, **islamic_civil**, **islamic_tbla**, **islamic_umalqura**, **japanese**, and **persian**. If **type** is left unspecified, the default calendar type of the locale is used.
Call the **getCalendar** method to obtain the time zone object of a specific locale and type (**i18n** is the name of the imported module). **type** indicates the valid calendar type, for example, **buddhist**, **chinese**, **coptic**, **ethiopic**, **hebrew**, **gregory**, **indian**, **islamic_civil**, **islamic_tbla**, **islamic_umalqura**, **japanese**, and **persian**. If **type** is left unspecified, the default calendar type of the locale is used.
...
@@ -113,8 +113,8 @@ APIs are provided to access the system language and region information.
...
@@ -113,8 +113,8 @@ APIs are provided to access the system language and region information.
var calendar = i18n.getCalendar("zh-CN", "gregory);
var calendar = i18n.getCalendar("zh-CN", "gregory);
```
```
2. Set the time for the **Calendar** object.
2. Set the time for the **Calendar** object.<br>
Call the **setTime** method to set the time of the **Calendar** object. This method receives two types of parameters. One is a **Date** object, and the other is a value indicating the number of milliseconds elapsed since January 1, 1970, 00:00:00 GMT.
Call the **setTime** method to set the time of the **Calendar** object. This method receives two types of parameters. One is a **Date** object, and the other is a value indicating the number of milliseconds elapsed since January 1, 1970, 00:00:00 GMT.
```
```
var date1 = new Date();
var date1 = new Date();
...
@@ -123,14 +123,14 @@ APIs are provided to access the system language and region information.
...
@@ -123,14 +123,14 @@ APIs are provided to access the system language and region information.
calendar.setTime(date2);
calendar.setTime(date2);
```
```
3. Set the year, month, day, hour, minute, and second for the **Calendar** object.
3. Set the year, month, day, hour, minute, and second for the **Calendar** object.<br>
Call the **set** method to set the year, month, day, hour, minute, and second for the **Calendar** object.
Call the **set** method to set the year, month, day, hour, minute, and second for the **Calendar** object.
```
```
calendar.set(2021, 12, 21, 6, 0, 0)
calendar.set(2021, 12, 21, 6, 0, 0)
```
```
4. Set and obtain the time zone for the **Calendar** object.
4. Set and obtain the time zone for the **Calendar** object.<br>
Call the **setTimeZone** and **getTimeZone** methods to set and obtain the time zone for the **Calendar** object. The **setTimeZone** method requires an input string to indicate the time zone to be set.
Call the **setTimeZone** and **getTimeZone** methods to set and obtain the time zone for the **Calendar** object. The **setTimeZone** method requires an input string to indicate the time zone to be set.
...
@@ -139,7 +139,7 @@ APIs are provided to access the system language and region information.
...
@@ -139,7 +139,7 @@ APIs are provided to access the system language and region information.
var timezone = calendar.getTimeZone();
var timezone = calendar.getTimeZone();
```
```
5. Set and obtain the first day of a week for the **Calendar** object.
5. Set and obtain the first day of a week for the **Calendar** object.<br>
Call the **setFirstDayOfWeek** and **getFirstDayOfWeek** methods to set and obtain the first day of a week for the **Calendar** object. **setFirstDayOfWeek** must be set to a value indicating the first day of a week. The value **1** indicates Sunday, and the value **7** indicates Saturday.
Call the **setFirstDayOfWeek** and **getFirstDayOfWeek** methods to set and obtain the first day of a week for the **Calendar** object. **setFirstDayOfWeek** must be set to a value indicating the first day of a week. The value **1** indicates Sunday, and the value **7** indicates Saturday.
...
@@ -148,15 +148,15 @@ APIs are provided to access the system language and region information.
...
@@ -148,15 +148,15 @@ APIs are provided to access the system language and region information.
var firstDayOfWeek = calendar.getFirstDayOfWeek();
var firstDayOfWeek = calendar.getFirstDayOfWeek();
```
```
6. Set and obtain the minimum count of days in the first week for the **Calendar** object.
6. Set and obtain the minimum count of days in the first week for the **Calendar** object.<br>
Call the **setMinimalDaysInFirstWeek** and **getMinimalDaysInFirstWeek** methods to set and obtain the minimum count of days in the first week for the **Calendar** object.
Call the **setMinimalDaysInFirstWeek** and **getMinimalDaysInFirstWeek** methods to set and obtain the minimum count of days in the first week for the **Calendar** object.
```
```
calendar.setMinimalDaysInFirstWeek(3);
calendar.setMinimalDaysInFirstWeek(3);
var minimalDaysInFirstWeek = calendar.getMinimalDaysInFirstWeek();
var minimalDaysInFirstWeek = calendar.getMinimalDaysInFirstWeek();
```
```
7. Obtain the localized display of the **Calendar** object.
7. Obtain the localized display of the **Calendar** object.<br>
Call the **getDisplayName** method to obtain the localized display of the **Calendar** object.
Call the **getDisplayName** method to obtain the localized display of the **Calendar** object.
...
@@ -164,7 +164,7 @@ APIs are provided to access the system language and region information.
...
@@ -164,7 +164,7 @@ APIs are provided to access the system language and region information.
var localizedName = calendar.getDisplayName("zh-CN");
var localizedName = calendar.getDisplayName("zh-CN");
```
```
8. Check whether a date is a weekend.
8. Check whether a date is a weekend.<br>
Call the **isWeekend** method to determine whether the input date is a weekend.
Call the **isWeekend** method to determine whether the input date is a weekend.
...
@@ -181,7 +181,7 @@ APIs are provided to access the system language and region information.
...
@@ -181,7 +181,7 @@ APIs are provided to access the system language and region information.
| ohos.i18n | isValidNumber(number: string): boolean<sup>8+</sup> | Checks whether the value of **number** is a phone number in the correct format. |
| ohos.i18n | isValidNumber(number: string): boolean<sup>8+</sup> | Checks whether the value of **number** is a phone number in the correct format. |
...
@@ -190,7 +190,7 @@ APIs are provided to access the system language and region information.
...
@@ -190,7 +190,7 @@ APIs are provided to access the system language and region information.
### How to Develop
### How to Develop
1. Instantiate a **PhoneNumberFormat** object.
1. Instantiate a **PhoneNumberFormat** object.<br>
Call the **PhoneNumberFormat** constructor to instantiate a **PhoneNumberFormat** object. The country code and formatting options of the phone number need to be passed into this constructor. The formatting options are optional, including a style option. Values of this option include: **E164**, **INTERNATIONAL**, **NATIONAL**, and **RFC3966**.
Call the **PhoneNumberFormat** constructor to instantiate a **PhoneNumberFormat** object. The country code and formatting options of the phone number need to be passed into this constructor. The formatting options are optional, including a style option. Values of this option include: **E164**, **INTERNATIONAL**, **NATIONAL**, and **RFC3966**.
...
@@ -199,14 +199,14 @@ APIs are provided to access the system language and region information.
...
@@ -199,14 +199,14 @@ APIs are provided to access the system language and region information.
```
```
2. Check whether the phone number format is correct.
2. Check whether the phone number format is correct.
Call the **isValidNumber** method to check whether the format of the input phone number is correct.
Call the **isValidNumber** method to check whether the format of the input phone number is correct.
```
```
var validNumber = phoneNumberFormat.isValidNumber("15812341234");
var validNumber = phoneNumberFormat.isValidNumber("15812341234");
```
```
3. Format a phone number.
3. Format a phone number.
Call the **format** method of **PhoneNumberFormat** to format the input phone number.
Call the **format** method of **PhoneNumberFormat** to format the input phone number.
```
```
var formattedNumber = phoneNumberFormat.format("15812341234");
var formattedNumber = phoneNumberFormat.format("15812341234");
...
@@ -258,7 +258,7 @@ An API can be called to implement measurement conversion.
...
@@ -258,7 +258,7 @@ An API can be called to implement measurement conversion.
### How to Develop
### How to Develop
1. Instantiate an **IndexUtil** object.
1. Instantiate an **IndexUtil** object.<br>
Call the **getInstance** method to instantiate an **IndexUtil** object for a specific locale. When the **locale** parameter is empty, instantiate an **IndexUtil** object of the default locale.
Call the **getInstance** method to instantiate an **IndexUtil** object for a specific locale. When the **locale** parameter is empty, instantiate an **IndexUtil** object of the default locale.
...
@@ -266,22 +266,22 @@ An API can be called to implement measurement conversion.
...
@@ -266,22 +266,22 @@ An API can be called to implement measurement conversion.
var indexUtil = getInstance("zh-CN");
var indexUtil = getInstance("zh-CN");
```
```
2. Obtain the index list.
2. Obtain the index list.<br>
Call the **getIndexList** method to obtain the alphabet index list of the current locale.
Call the **getIndexList** method to obtain the alphabet index list of the current locale.
```
```
var indexList = indexUtil.getIndexList();
var indexList = indexUtil.getIndexList();
```
```
3. Add an index.
3. Add an index.<br>
Call the **addLocale** method to add the alphabet index of a new locale to the current index list.
Call the **addLocale** method to add the alphabet index of a new locale to the current index list.
```
```
indexUtil.addLocale("ar")
indexUtil.addLocale("ar")
```
```
4. Obtain the index of a string.
4. Obtain the index of a string.<br>
Call the **getIndex** method to obtain the alphabet index of a string.
Call the **getIndex** method to obtain the alphabet index of a string.
```
```
var text = "access index";
var text = "access index";
...
@@ -312,7 +312,7 @@ When a text is displayed in more than one line, [BreakIterator](../reference/api
...
@@ -312,7 +312,7 @@ When a text is displayed in more than one line, [BreakIterator](../reference/api
### How to Develop
### How to Develop
1. Instantiate a **BreakIterator** object.
1. Instantiate a **BreakIterator** object.<br>
Call the **getLineInstance** method to instantiate a **BreakIterator** object.
Call the **getLineInstance** method to instantiate a **BreakIterator** object.
...
@@ -321,7 +321,7 @@ When a text is displayed in more than one line, [BreakIterator](../reference/api
...
@@ -321,7 +321,7 @@ When a text is displayed in more than one line, [BreakIterator](../reference/api
var breakIterator = i18n.getLineInstance(locale);
var breakIterator = i18n.getLineInstance(locale);
```
```
2. Set and access the text that requires line breaking.
2. Set and access the text that requires line breaking.<br>
Call the **setLineBreakText** and **getLineBreakText** methods to set and access the text that requires line breaking.
Call the **setLineBreakText** and **getLineBreakText** methods to set and access the text that requires line breaking.
...
@@ -331,7 +331,7 @@ When a text is displayed in more than one line, [BreakIterator](../reference/api
...
@@ -331,7 +331,7 @@ When a text is displayed in more than one line, [BreakIterator](../reference/api
var breakText = breakIterator.getLineBreakText();
var breakText = breakIterator.getLineBreakText();
```
```
3. Obtain the current position of the **BreakIterator** object.
3. Obtain the current position of the **BreakIterator** object.<br>
Call the **current** method to obtain the current position of the **BreakIterator** object in the text being processed.
Call the **current** method to obtain the current position of the **BreakIterator** object in the text being processed.
...
@@ -339,7 +339,7 @@ When a text is displayed in more than one line, [BreakIterator](../reference/api
...
@@ -339,7 +339,7 @@ When a text is displayed in more than one line, [BreakIterator](../reference/api
var pos = breakIterator.current();
var pos = breakIterator.current();
```
```
4. Set the position of a **BreakIterator** object.
4. Set the position of a **BreakIterator** object.<br>
The following APIs are provided to adjust the **first**, **last**, **next**, **previous**, or **following** position of the **BreakIterator** object in the text to be processed.
The following APIs are provided to adjust the **first**, **last**, **next**, **previous**, or **following** position of the **BreakIterator** object in the text to be processed.
...
@@ -355,7 +355,7 @@ When a text is displayed in more than one line, [BreakIterator](../reference/api
...
@@ -355,7 +355,7 @@ When a text is displayed in more than one line, [BreakIterator](../reference/api
var followingPos = breakIterator.following(10);
var followingPos = breakIterator.following(10);
```
```
5. Determine whether a position is a break point.
5. Determine whether a position is a break point.<br>
Call the **isBoundary** method to determine whether a position is a break point. If yes, **true** is returned and the **BreakIterator** object is moved to this position. If no, **false** is returned and the **BreakIterator** object is moved to a break point after this position.
Call the **isBoundary** method to determine whether a position is a break point. If yes, **true** is returned and the **BreakIterator** object is moved to this position. If no, **false** is returned and the **BreakIterator** object is moved to a break point after this position.
This development guide describes how to use i18n APIs that are defined in ECMA 402.
This development guide describes how to use i18n APIs that are defined in ECMA 402.
> **NOTE**<br>
> In the code snippets in this document, **intl** refers to the name of the imported module.
## Setting Locale Information
## Setting Locale Information
Use [Locale](../reference/apis/js-apis-intl.md) APIs to maximize or minimize locale information.
Use [Locale](../reference/apis/js-apis-intl.md) APIs to maximize or minimize locale information.
...
@@ -21,7 +24,7 @@ Use [Locale](../reference/apis/js-apis-intl.md) APIs to maximize or minimize loc
...
@@ -21,7 +24,7 @@ Use [Locale](../reference/apis/js-apis-intl.md) APIs to maximize or minimize loc
### How to Develop
### How to Develop
1. Instantiate a **Locale** object.<br>
1. Instantiate a **Locale** object.<br>
Create a **Locale** object by using the **Locale** constructor. This method receives a string representing the locale and an optional [Attributes](../reference/apis/js-apis-intl.md) list. In the code below, **intl** is the name of the imported module.
Create a **Locale** object by using the **Locale** constructor. This method receives a string representing the locale and an optional [Attributes](../reference/apis/js-apis-intl.md) list.
```
```
...
@@ -71,7 +74,7 @@ Use [DateTimeFormat](../reference/apis/js-apis-intl.md) APIs to format the date
...
@@ -71,7 +74,7 @@ Use [DateTimeFormat](../reference/apis/js-apis-intl.md) APIs to format the date
### How to Develop
### How to Develop
1. Instantiate a **DateTimeFormat** object.<br>
1. Instantiate a **DateTimeFormat** object.<br>
Use the default constructor of **DateTimeFormat** to obtain the system default locale by accessing the system language and region settings, and set it as the locale in the **DateTimeFormat** object. In the code below, **intl** is the name of the imported module.
Use the default constructor of **DateTimeFormat** to obtain the system default locale by accessing the system language and region settings, and set it as the locale in the **DateTimeFormat** object.
```
```
...
@@ -86,7 +89,7 @@ Use [DateTimeFormat](../reference/apis/js-apis-intl.md) APIs to format the date
...
@@ -86,7 +89,7 @@ Use [DateTimeFormat](../reference/apis/js-apis-intl.md) APIs to format the date
```
```
2. Format the date and time.<br>
2. Format the date and time.<br>
Use the **format** method of **DateTimeFormat** to format a **Date** object. This method returns a string representing the formatting result.
Call the **format** method to format a **Date** object. This method returns a string representing the formatting result.
```
```
Date date = new Date();
Date date = new Date();
...
@@ -94,7 +97,7 @@ Use [DateTimeFormat](../reference/apis/js-apis-intl.md) APIs to format the date
...
@@ -94,7 +97,7 @@ Use [DateTimeFormat](../reference/apis/js-apis-intl.md) APIs to format the date
```
```
3. Format a period.<br>
3. Format a period.<br>
Use the **formatRange** method of **DateTimeFormat** to format a period. This method requires input of two **Date** objects, which respectively indicate the start date and end date of a period. This method returns a string representing the formatting result.
Call the **formatRange** method to format a period. This method requires input of two **Date** objects, which respectively indicate the start date and end date of a period. This method returns a string representing the formatting result.
```
```
Date startDate = new Date();
Date startDate = new Date();
...
@@ -103,7 +106,7 @@ Use [DateTimeFormat](../reference/apis/js-apis-intl.md) APIs to format the date
...
@@ -103,7 +106,7 @@ Use [DateTimeFormat](../reference/apis/js-apis-intl.md) APIs to format the date
```
```
4. Obtain attributes of the **DateTimeFormat** object.<br>
4. Obtain attributes of the **DateTimeFormat** object.<br>
The **resolvedOptions** method of **DateTimeFormat** returns an object that contains all related attributes and values of the **DateTimeFormat** object.
Call the **resolvedOptions** method to obtain attributes of the **DateTimeFormat** object. This method will return an array that contains all attributes and values of the object.
```
```
var options = dateTimeFormat.resolvedOptions();
var options = dateTimeFormat.resolvedOptions();
...
@@ -122,13 +125,13 @@ Use [NumberFormat](../reference/apis/js-apis-intl.md) APIs to format a number fo
...
@@ -122,13 +125,13 @@ Use [NumberFormat](../reference/apis/js-apis-intl.md) APIs to format a number fo
| ohos.intl | constructor()<sup>8+</sup> | Creates a **NumberFormat** object. |
| ohos.intl | constructor()<sup>8+</sup> | Creates a **NumberFormat** object. |
| ohos.intl | constructor(locale: string \| Array<string>, options?: NumberOptions) | Creates a **NumberFormat** object and sets the locale and other formatting-related attributes. |
| ohos.intl | constructor(locale: string \| Array<string>, options?: NumberOptions) | Creates a **NumberFormat** object and sets the locale and other formatting-related attributes. |
| ohos.intl | format(number: number): string | Calculates the number based on the locale and other formatting-related attributes of the **NumberFormat** object. |
| ohos.intl | format(number: number): string | Calculates the number based on the locale and other formatting-related attributes of the **NumberFormat** object. |
| ohos.intl | resolvedOptions(): NumberOptions | Obtains the attributes of the **NumberFormat** object. |
| ohos.intl | resolvedOptions(): NumberOptions | Obtains attributes of the **NumberFormat** object. |
### How to Develop
### How to Develop
1. Instantiate a **NumberFormat** object.<br>
1. Instantiate a **NumberFormat** object.<br>
Use the default constructor of **NumberFormat** to obtain the system default locale by accessing the system language and region settings, and set it as the locale in the **NumberFormat** object. In the code below, **intl** is the name of the imported module.
Use the default constructor of **NumberFormat** to obtain the system default locale by accessing the system language and region settings, and set it as the locale in the **NumberFormat** object.
```
```
...
@@ -143,7 +146,7 @@ Use [NumberFormat](../reference/apis/js-apis-intl.md) APIs to format a number fo
...
@@ -143,7 +146,7 @@ Use [NumberFormat](../reference/apis/js-apis-intl.md) APIs to format a number fo
```
```
2. Format a number.<br>
2. Format a number.<br>
Use the **format** method of **NumberFormat** to format a number. A string is returned as the formatting result.
Call the **format** method to format a number. A string is returned as the formatting result.
```
```
var number = 1234.5678
var number = 1234.5678
...
@@ -151,7 +154,7 @@ Use [NumberFormat](../reference/apis/js-apis-intl.md) APIs to format a number fo
...
@@ -151,7 +154,7 @@ Use [NumberFormat](../reference/apis/js-apis-intl.md) APIs to format a number fo
```
```
3. Obtain attributes of the **NumberFormat** object.<br>
3. Obtain attributes of the **NumberFormat** object.<br>
The **resolvedOptions** method of NumberFormat returns an object that contains all related attributes and values of the **NumberFormat** object.
Call the **resolvedOptions** method to obtain attributes of the **NumberFormat** object. This method will return an array that contains all attributes and values of the object.
```
```
var options = numberFormat.resolvedOptions();
var options = numberFormat.resolvedOptions();
...
@@ -170,13 +173,13 @@ Use [Collator](../reference/apis/js-apis-intl.md) APIs to sort strings based on
...
@@ -170,13 +173,13 @@ Use [Collator](../reference/apis/js-apis-intl.md) APIs to sort strings based on
| ohos.intl | constructor()<sup>8+</sup> | Creates a **Collator** object. |
| ohos.intl | constructor()<sup>8+</sup> | Creates a **Collator** object. |
| ohos.intl | constructor(locale: string \| Array<string>, options?: CollatorOptions)<sup>8+</sup> | Creates a **Collator** object and sets the locale and other related attributes. |
| ohos.intl | constructor(locale: string \| Array<string>, options?: CollatorOptions)<sup>8+</sup> | Creates a **Collator** object and sets the locale and other related attributes. |
| ohos.intl | compare(first: string, second: string): number<sup>8+</sup> | Calculates the comparison result of two strings based on the locale and other attributes of the **Collator** object. |
| ohos.intl | compare(first: string, second: string): number<sup>8+</sup> | Calculates the comparison result of two strings based on the locale and other attributes of the **Collator** object. |
| ohos.intl | resolvedOptions(): CollatorOptions<sup>8+</sup> | Obtains the attributes of the **Collator** object. |
| ohos.intl | resolvedOptions(): CollatorOptions<sup>8+</sup> | Obtains attributes of the **Collator** object. |
### How to Develop
### How to Develop
1. Instantiate a **Collator** object.<br>
1. Instantiate a **Collator** object.<br>
Use the default constructor of **Collator** to obtain the system default locale by accessing the system language and region settings, and set it as the locale in the **Collator** object. In the code below, **intl** is the name of the imported module.
Use the default constructor of **Collator** to obtain the system default locale by accessing the system language and region settings, and set it as the locale in the **Collator** object.
```
```
...
@@ -190,7 +193,7 @@ Use [Collator](../reference/apis/js-apis-intl.md) APIs to sort strings based on
...
@@ -190,7 +193,7 @@ Use [Collator](../reference/apis/js-apis-intl.md) APIs to sort strings based on
```
```
2. Compare two strings.<br>
2. Compare two strings.<br>
Use the **compare** method of **Collator** to compare two input strings. This method returns a value as the comparison result. The return value **-1** indicates that the first string is shorter than the second string, the return value **1** indicates that the first string is longer than the second string, and the return value **0** indicates that the two strings are of equal lengths.
Call the **compare** method to compare two input strings. This method returns a value as the comparison result. The return value **-1** indicates that the first string is shorter than the second string, the return value **1** indicates that the first string is longer than the second string, and the return value **0** indicates that the two strings are of equal lengths.
```
```
var str1 = "first string";
var str1 = "first string";
...
@@ -199,7 +202,7 @@ Use [Collator](../reference/apis/js-apis-intl.md) APIs to sort strings based on
...
@@ -199,7 +202,7 @@ Use [Collator](../reference/apis/js-apis-intl.md) APIs to sort strings based on
```
```
3. Obtain attributes of the **Collator** object.<br>
3. Obtain attributes of the **Collator** object.<br>
The **resolvedOptions** method of **Collator** returns an object that contains all related attributes and values of the **Collator** object.
Call the **resolvedOptions** method to obtain attributes of the **Collator** object. This method will return an array that contains all attributes and values of the object.
```
```
var options = collator.resolvedOptions();
var options = collator.resolvedOptions();
...
@@ -223,7 +226,7 @@ Use [PluralRules](../reference/apis/js-apis-intl.md) APIs to determine the singu
...
@@ -223,7 +226,7 @@ Use [PluralRules](../reference/apis/js-apis-intl.md) APIs to determine the singu
### How to Develop
### How to Develop
1. Instantiate a **PluralRules** object.<br>
1. Instantiate a **PluralRules** object.<br>
Use the default constructor of **PluralRules** to obtain the system default locale by accessing the system language and region settings, and set it as the locale in the **PluralRules** object. In the code below, **intl** is the name of the imported module.
Use the default constructor of **PluralRules** to obtain the system default locale by accessing the system language and region settings, and set it as the locale in the **PluralRules** object.
```
```
...
@@ -236,8 +239,8 @@ Use [PluralRules](../reference/apis/js-apis-intl.md) APIs to determine the singu
...
@@ -236,8 +239,8 @@ Use [PluralRules](../reference/apis/js-apis-intl.md) APIs to determine the singu
var plurals = new intl.PluralRules("zh-CN", {localeMatcher: "best fit", type: "cardinal"};
var plurals = new intl.PluralRules("zh-CN", {localeMatcher: "best fit", type: "cardinal"};
```
```
2. Determine the singular or plural category.<br>
2. Determine the singular-plural type.<br>
Use the **select** method of **PluralRules** to determine the singular-plural type for an input number. This method returns a string as the category of the input number, which can be any of the following: **zero**, **one**, **two**, **few**, **many**, and **other**.
Call the **select** method to determine the singular-plural type of an input number. This method will return a string representing the singular-plural type, which can be any of the following: **zero**, **one**, **two**, **few**, **many**, and **other**.
```
```
var number = 1234.5678
var number = 1234.5678
...
@@ -258,13 +261,13 @@ Use [RelativeTimeFormat](../reference/apis/js-apis-intl.md) APIs to format the r
...
@@ -258,13 +261,13 @@ Use [RelativeTimeFormat](../reference/apis/js-apis-intl.md) APIs to format the r
| ohos.intl | constructor(locale: string \| Array<string>, options?: RelativeTimeFormatInputOptions)<sup>8+</sup> | Creates a **RelativeTimeFormat** object and sets the locale and other formatting-related attributes. |
| ohos.intl | constructor(locale: string \| Array<string>, options?: RelativeTimeFormatInputOptions)<sup>8+</sup> | Creates a **RelativeTimeFormat** object and sets the locale and other formatting-related attributes. |
| ohos.intl | format(value: number, unit: string): string<sup>8+</sup> | Calculates the relative time format based on the locale and other formatting-related attributes of the **RelativeTimeFormat** object. |
| ohos.intl | format(value: number, unit: string): string<sup>8+</sup> | Calculates the relative time format based on the locale and other formatting-related attributes of the **RelativeTimeFormat** object. |
| ohos.intl | formatToParts(value: number, unit: string): Array<object><sup>8+</sup> | Returns each part of the relative time format based on the locale and other formatting-related attributes of the **RelativeTimeFormat** object. |
| ohos.intl | formatToParts(value: number, unit: string): Array<object><sup>8+</sup> | Returns each part of the relative time format based on the locale and other formatting-related attributes of the **RelativeTimeFormat** object. |
| ohos.intl | resolvedOptions(): RelativeTimeFormatResolvedOptions<sup>8+</sup> | Obtains the attributes of the **RelativeTimeFormat** object. |
| ohos.intl | resolvedOptions(): RelativeTimeFormatResolvedOptions<sup>8+</sup> | Obtains attributes of the **RelativeTimeFormat** object. |
### How to Develop
### How to Develop
1. Instantiate a **RelativeTimeFormat** object.<br>
1. Instantiate a **RelativeTimeFormat** object.<br>
Use the default constructor of **RelativeTimeFormat** to obtain the system default locale by accessing the system language and region settings, and set it as the locale in the **RelativeTimeFormat** object. In the code below, **intl** is the name of the imported module.
Use the default constructor of **RelativeTimeFormat** to obtain the system default locale by accessing the system language and region settings, and set it as the locale in the **RelativeTimeFormat** object.
```
```
...
@@ -278,7 +281,7 @@ Use [RelativeTimeFormat](../reference/apis/js-apis-intl.md) APIs to format the r
...
@@ -278,7 +281,7 @@ Use [RelativeTimeFormat](../reference/apis/js-apis-intl.md) APIs to format the r
```
```
2. Format the relative time.<br>
2. Format the relative time.<br>
Use the **format** method of **RelativeTimeFormat** to format the relative time. This method receives a numeric value representing the time length and a string-form unit, like **year**, **quarter**, **month**, **week**, **day**, **hour**, **minute**, and **second**. This method returns a string representing the formatting result.
Call the **format** method to format the relative time. This method receives a numeric value representing the time length and a string-form unit, like **year**, **quarter**, **month**, **week**, **day**, **hour**, **minute**, and **second**. This method returns a string representing the formatting result.
```
```
var number = 2;
var number = 2;
...
@@ -296,7 +299,7 @@ Use [RelativeTimeFormat](../reference/apis/js-apis-intl.md) APIs to format the r
...
@@ -296,7 +299,7 @@ Use [RelativeTimeFormat](../reference/apis/js-apis-intl.md) APIs to format the r
```
```
4. Obtain attributes of the **RelativeTimeFormat** object.<br>
4. Obtain attributes of the **RelativeTimeFormat** object.<br>
The **resolvedOptions** method of **RelativeTimeFormat** returns an object that contains all related attributes and values of the **RelativeTimeFormat** object. For a full list of attributes, see [ RelativeTimeFormatResolvedOptions](../reference/apis/js-apis-intl.md).
Call the **resolvedOptions** method to obtain attributes of the **RelativeTimeFormat** object. This method will return an array that contains all attributes and values of the object. For a full list of attributes, see [ RelativeTimeFormatResolvedOptions](../reference/apis/js-apis-intl.md).