mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-11-27 17:31:12 +00:00
1f928ed949
Signed-off-by: wangcaoyu1 <wangcaoyu@huawei.com>
2926 lines
71 KiB
TypeScript
2926 lines
71 KiB
TypeScript
/*
|
|
* Copyright (c) 2021 Huawei Device Co., Ltd.
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
* @kit LocalizationKit
|
|
*/
|
|
|
|
/**
|
|
* Provides internationalization related APIs.
|
|
*
|
|
* @namespace intl
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Provides internationalization related APIs.
|
|
*
|
|
* @namespace intl
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Provides internationalization related APIs.
|
|
*
|
|
* @namespace intl
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
declare namespace intl {
|
|
/**
|
|
* Provides the options of Locale.
|
|
*
|
|
* @interface LocaleOptions
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Provides the options of Locale.
|
|
*
|
|
* @interface LocaleOptions
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Provides the options of Locale.
|
|
*
|
|
* @interface LocaleOptions
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
export interface LocaleOptions {
|
|
/**
|
|
* Indicates the calendar.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the calendar.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the calendar.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the calendar.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
calendar?: string;
|
|
|
|
/**
|
|
* Indicates the collation.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the collation.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the collation.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the collation.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
collation?: string;
|
|
|
|
/**
|
|
* Indicates the hourCycle.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the hourCycle.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the hourCycle.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the hourCycle.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
hourCycle?: string;
|
|
|
|
/**
|
|
* Indicates the numberingSystem.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the numberingSystem.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the numberingSystem.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the numberingSystem.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
numberingSystem?: string;
|
|
|
|
/**
|
|
* Indicates the numeric.
|
|
*
|
|
* @type { boolean }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the numeric.
|
|
*
|
|
* @type { ?boolean }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the numeric.
|
|
*
|
|
* @type { ?boolean }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the numeric.
|
|
*
|
|
* @type { ?boolean }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
numeric?: boolean;
|
|
|
|
/**
|
|
* Indicates the caseFirst.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the caseFirst.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the caseFirst.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the caseFirst.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
caseFirst?: string;
|
|
}
|
|
|
|
/**
|
|
* Provides APIs for obtaining locale information.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Provides APIs for obtaining locale information.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Provides APIs for obtaining locale information.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
export class Locale {
|
|
/**
|
|
* A constructor used to create a Locale object.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* A constructor used to create a Locale object.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* A constructor used to create a Locale object.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
constructor();
|
|
|
|
/**
|
|
* A constructor used to create a Locale object.
|
|
*
|
|
* @param { string } locale - Indicates a character string containing the locale information, including
|
|
* the language and optionally the script and region.
|
|
* @param { LocaleOptions } options - Indicates Locale option object use to initialize the Locale object.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* A constructor used to create a Locale object.
|
|
*
|
|
* @param { string } locale - Indicates a character string containing the locale information, including
|
|
* the language and optionally the script and region.
|
|
* @param { LocaleOptions } options - Indicates Locale option object use to initialize the Locale object.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* A constructor used to create a Locale object.
|
|
*
|
|
* @param { string } locale - Indicates a character string containing the locale information, including
|
|
* the language and optionally the script and region.
|
|
* @param { LocaleOptions } options - Indicates Locale option object use to initialize the Locale object.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
constructor(locale: string, options?: LocaleOptions);
|
|
|
|
/**
|
|
* Indicates the language of the locale.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the language of the locale.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the language of the locale.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
language: string;
|
|
|
|
/**
|
|
* Indicates the script of the locale.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the script of the locale.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the script of the locale.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
script: string;
|
|
|
|
/**
|
|
* Indicates the region of the locale.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the region of the locale.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the region of the locale.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
region: string;
|
|
|
|
/**
|
|
* Indicates the basic locale information, which is returned as a substring of
|
|
* a complete locale string.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the basic locale information, which is returned as a substring of
|
|
* a complete locale string.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the basic locale information, which is returned as a substring of
|
|
* a complete locale string.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
baseName: string;
|
|
|
|
/**
|
|
* Indicates the case first style of the locale.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the case first style of the locale.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the case first style of the locale.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
caseFirst: string;
|
|
|
|
/**
|
|
* Indicates the calendar.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the calendar.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the calendar.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
calendar: string;
|
|
|
|
/**
|
|
* Indicates the collation.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the collation.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the collation.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
collation: string;
|
|
|
|
/**
|
|
* Indicates the hour cycle.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the hour cycle.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the hour cycle.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
hourCycle: string;
|
|
|
|
/**
|
|
* Indicates the numbering system.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the numbering system.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the numbering system.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
numberingSystem: string;
|
|
|
|
/**
|
|
* Indicates whether it is numeric.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates whether it is numeric.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates whether it is numeric.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
numeric: boolean;
|
|
|
|
/**
|
|
* Convert the locale information to string.
|
|
*
|
|
* @returns { string } locale information in string form.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Convert the locale information to string.
|
|
*
|
|
* @returns { string } locale information in string form.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Convert the locale information to string.
|
|
*
|
|
* @returns { string } locale information in string form.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
toString(): string;
|
|
|
|
/**
|
|
* Maximize the locale's base information.
|
|
*
|
|
* @returns { Locale } maximized locale.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Maximize the locale's base information.
|
|
*
|
|
* @returns { Locale } maximized locale.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Maximize the locale's base information.
|
|
*
|
|
* @returns { Locale } maximized locale.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
maximize(): Locale;
|
|
|
|
/**
|
|
* Minimize the locale's base information.
|
|
*
|
|
* @returns { Locale } minimized locale.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Minimize the locale's base information.
|
|
*
|
|
* @returns { Locale } minimized locale.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Minimize the locale's base information.
|
|
*
|
|
* @returns { Locale } minimized locale.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
minimize(): Locale;
|
|
}
|
|
|
|
/**
|
|
* Provides the options of date time format.
|
|
*
|
|
* @interface DateTimeOptions
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Provides the options of date time format.
|
|
*
|
|
* @interface DateTimeOptions
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Provides the options of date time format.
|
|
*
|
|
* @interface DateTimeOptions
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
export interface DateTimeOptions {
|
|
/**
|
|
* Indicates the locale.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the locale.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the locale.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the locale.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
locale?: string;
|
|
|
|
/**
|
|
* Indicates the dateStyle.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the dateStyle.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the dateStyle.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the dateStyle.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
dateStyle?: string;
|
|
|
|
/**
|
|
* Indicates the timeStyle.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the timeStyle.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the timeStyle.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the timeStyle.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
timeStyle?: string;
|
|
|
|
/**
|
|
* Indicates the hourCycle.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the hourCycle.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the hourCycle.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the hourCycle.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
hourCycle?: string;
|
|
|
|
/**
|
|
* Indicates the timeZone.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the timeZone.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the timeZone.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the timeZone.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
timeZone?: string;
|
|
|
|
/**
|
|
* Indicates the numberingSystem.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the numberingSystem.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the numberingSystem.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the numberingSystem.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
numberingSystem?: string;
|
|
|
|
/**
|
|
* Indicates the hour12.
|
|
*
|
|
* @type { boolean }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the hour12.
|
|
*
|
|
* @type { ?boolean }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the hour12.
|
|
*
|
|
* @type { ?boolean }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the hour12.
|
|
*
|
|
* @type { ?boolean }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
hour12?: boolean;
|
|
|
|
/**
|
|
* Indicates the weekday.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the weekday.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the weekday.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the weekday.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
weekday?: string;
|
|
|
|
/**
|
|
* Indicates the era.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the era.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the era.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the era.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
era?: string;
|
|
|
|
/**
|
|
* Indicates the year.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the year.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the year.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the year.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
year?: string;
|
|
|
|
/**
|
|
* Indicates the month.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the month.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the month.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the month.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
month?: string;
|
|
|
|
/**
|
|
* Indicates the day.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the day.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the day.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the day.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
day?: string;
|
|
|
|
/**
|
|
* Indicates the hour.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the hour.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the hour.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the hour.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
hour?: string;
|
|
|
|
/**
|
|
* Indicates the minute.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the minute.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the minute.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the minute.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
minute?: string;
|
|
|
|
/**
|
|
* Indicates the second.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the second.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the second.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the second.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
second?: string;
|
|
|
|
/**
|
|
* Indicates the timeZoneName.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the timeZoneName.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the timeZoneName.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the timeZoneName.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
timeZoneName?: string;
|
|
|
|
/**
|
|
* Indicates the dayPeriod.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the dayPeriod.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the dayPeriod.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the dayPeriod.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
dayPeriod?: string;
|
|
|
|
/**
|
|
* Indicates the localeMatcher.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the localeMatcher.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the localeMatcher.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the localeMatcher.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
localeMatcher?: string;
|
|
|
|
/**
|
|
* Indicates the formatMatcher.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the formatMatcher.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the formatMatcher.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Indicates the formatMatcher.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
formatMatcher?: string;
|
|
}
|
|
|
|
/**
|
|
* Provides the API for formatting date strings.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Provides the API for formatting date strings.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Provides the API for formatting date strings.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
export class DateTimeFormat {
|
|
/**
|
|
* A constructor used to create a DateTimeFormat object.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* A constructor used to create a DateTimeFormat object.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* A constructor used to create a DateTimeFormat object.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
constructor();
|
|
|
|
/**
|
|
* A constructor used to create a DateTimeFormat object.
|
|
*
|
|
* @param { string | Array<string> } locale - Indicates character string containing the locale information, including
|
|
* the language and optionally the script and region, for the DateTimeFormat object.
|
|
* @param { DateTimeOptions } [options] - Indicates the options used to format the date.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* A constructor used to create a DateTimeFormat object.
|
|
*
|
|
* @param { string | Array<string> } locale - Indicates character string containing the locale information, including
|
|
* the language and optionally the script and region, for the DateTimeFormat object.
|
|
* @param { DateTimeOptions } [options] - Indicates the options used to format the date.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* A constructor used to create a DateTimeFormat object.
|
|
*
|
|
* @param { string | Array<string> } locale - Indicates character string containing the locale information, including
|
|
* the language and optionally the script and region, for the DateTimeFormat object.
|
|
* @param { DateTimeOptions } [options] - Indicates the options used to format the date.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
constructor(locale: string | Array<string>, options?: DateTimeOptions);
|
|
|
|
/**
|
|
* Obtains the formatted date strings.
|
|
*
|
|
* @param { Date } date - Indicates the Date object to be formatted.
|
|
* @returns { string } a date string formatted based on the specified locale.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Obtains the formatted date strings.
|
|
*
|
|
* @param { Date } date - Indicates the Date object to be formatted.
|
|
* @returns { string } a date string formatted based on the specified locale.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Obtains the formatted date strings.
|
|
*
|
|
* @param { Date } date - Indicates the Date object to be formatted.
|
|
* @returns { string } a date string formatted based on the specified locale.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
format(date: Date): string;
|
|
|
|
/**
|
|
* Obtains the formatted date strings of a date range.
|
|
*
|
|
* @param { Date } startDate - Indicates the start date of the date range.
|
|
* @param { Date } endDate - Indicates the end date of the date range.
|
|
* @returns { string } a date string formatted based on the specified locale.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Obtains the formatted date strings of a date range.
|
|
*
|
|
* @param { Date } startDate - Indicates the start date of the date range.
|
|
* @param { Date } endDate - Indicates the end date of the date range.
|
|
* @returns { string } a date string formatted based on the specified locale.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Obtains the formatted date strings of a date range.
|
|
*
|
|
* @param { Date } startDate - Indicates the start date of the date range.
|
|
* @param { Date } endDate - Indicates the end date of the date range.
|
|
* @returns { string } a date string formatted based on the specified locale.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
formatRange(startDate: Date, endDate: Date): string;
|
|
|
|
/**
|
|
* Obtains the options of the DateTimeFormat object.
|
|
*
|
|
* @returns { DateTimeOptions } the options of the DateTimeFormat object.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Obtains the options of the DateTimeFormat object.
|
|
*
|
|
* @returns { DateTimeOptions } the options of the DateTimeFormat object.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
/**
|
|
* Obtains the options of the DateTimeFormat object.
|
|
*
|
|
* @returns { DateTimeOptions } the options of the DateTimeFormat object.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @form
|
|
* @since 11
|
|
*/
|
|
resolvedOptions(): DateTimeOptions;
|
|
}
|
|
|
|
/**
|
|
* Provides the options of number format.
|
|
*
|
|
* @interface NumberOptions
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Provides the options of number format.
|
|
*
|
|
* @interface NumberOptions
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
export interface NumberOptions {
|
|
/**
|
|
* Indicates the locale.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the locale.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the locale.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
locale?: string;
|
|
|
|
/**
|
|
* Indicates the currency.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the currency.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the currency.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
currency?: string;
|
|
|
|
/**
|
|
* Indicates the currencySign.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the currencySign.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the currencySign.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
currencySign?: string;
|
|
|
|
/**
|
|
* Indicates the currencyDisplay.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the currencyDisplay.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the currencyDisplay.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
currencyDisplay?: string;
|
|
|
|
/**
|
|
* Indicates the unit.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the unit.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the unit.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
unit?: string;
|
|
|
|
/**
|
|
* Indicates the unitDisplay.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the unitDisplay.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the unitDisplay.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
unitDisplay?: string;
|
|
|
|
/**
|
|
* Indicates the unitUsage.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Indicates the unitUsage.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the unitUsage.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
unitUsage?: string;
|
|
|
|
/**
|
|
* Indicates the signDisplay.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the signDisplay.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the signDisplay.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
signDisplay?: string;
|
|
|
|
/**
|
|
* Indicates the compactDisplay.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the compactDisplay.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the compactDisplay.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
compactDisplay?: string;
|
|
|
|
/**
|
|
* Indicates the notation.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the notation.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the notation.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
notation?: string;
|
|
|
|
/**
|
|
* Indicates the localeMatcher.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the localeMatcher.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the localeMatcher.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
localeMatcher?: string;
|
|
|
|
/**
|
|
* Indicates the style.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the style.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the style.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
style?: string;
|
|
|
|
/**
|
|
* Indicates the numberingSystem.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the numberingSystem.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the numberingSystem.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
numberingSystem?: string;
|
|
|
|
/**
|
|
* Indicates the useGrouping.
|
|
*
|
|
* @type { boolean }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the useGrouping.
|
|
*
|
|
* @type { ?boolean }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the useGrouping.
|
|
*
|
|
* @type { ?boolean }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
useGrouping?: boolean;
|
|
|
|
/**
|
|
* Indicates the minimumIntegerDigits.
|
|
*
|
|
* @type { number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the minimumIntegerDigits.
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the minimumIntegerDigits.
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
minimumIntegerDigits?: number;
|
|
|
|
/**
|
|
* Indicates the minimumFractionDigits.
|
|
*
|
|
* @type { number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the minimumFractionDigits.
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the minimumFractionDigits.
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
minimumFractionDigits?: number;
|
|
|
|
/**
|
|
* Indicates the maximumFractionDigits.
|
|
*
|
|
* @type { number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the maximumFractionDigits.
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the maximumFractionDigits.
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
maximumFractionDigits?: number;
|
|
|
|
/**
|
|
* Indicates the minimumSignificantDigits.
|
|
*
|
|
* @type { number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the minimumSignificantDigits.
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the minimumSignificantDigits.
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
minimumSignificantDigits?: number;
|
|
|
|
/**
|
|
* Indicates the maximumSignificantDigits.
|
|
*
|
|
* @type { number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Indicates the maximumSignificantDigits.
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Indicates the maximumSignificantDigits.
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
maximumSignificantDigits?: number;
|
|
}
|
|
|
|
/**
|
|
* Provides the API for formatting number strings.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Provides the API for formatting number strings.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
export class NumberFormat {
|
|
/**
|
|
* A constructor used to create a NumberFormat object.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* A constructor used to create a NumberFormat object.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
constructor();
|
|
|
|
/**
|
|
* A constructor used to create a NumberFormat object.
|
|
*
|
|
* @param { string | Array<string> } locale - Indicates a character string containing the locale information, including
|
|
* the language and optionally the script and region, for the NumberFormat object.
|
|
* @param { NumberOptions } [options] - Indicates the options used to format the number.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* A constructor used to create a NumberFormat object.
|
|
*
|
|
* @param { string | Array<string> } locale - Indicates a character string containing the locale information, including
|
|
* the language and optionally the script and region, for the NumberFormat object.
|
|
* @param { NumberOptions } [options] - Indicates the options used to format the number.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
constructor(locale: string | Array<string>, options?: NumberOptions);
|
|
|
|
/**
|
|
* Obtains the formatted number string.
|
|
*
|
|
* @param { number } number Indicates the number to be formatted.
|
|
* @returns { string } a number string formatted based on the specified locale.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Obtains the formatted number string.
|
|
*
|
|
* @param { number } number Indicates the number to be formatted.
|
|
* @returns { string } a number string formatted based on the specified locale.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
format(number: number): string;
|
|
|
|
/**
|
|
* Obtains the options of the NumberFormat object.
|
|
*
|
|
* @returns { NumberOptions } the options of the NumberFormat object.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 6
|
|
*/
|
|
/**
|
|
* Obtains the options of the NumberFormat object.
|
|
*
|
|
* @returns { NumberOptions } the options of the NumberFormat object.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
resolvedOptions(): NumberOptions;
|
|
}
|
|
|
|
/**
|
|
* Provides the options of Collator
|
|
*
|
|
* @interface CollatorOptions
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Provides the options of Collator
|
|
*
|
|
* @interface CollatorOptions
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
export interface CollatorOptions {
|
|
/**
|
|
* The locale matching algorithm to use.
|
|
* Possible values are "lookup" and "best fit"; the default is "best fit".
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* The locale matching algorithm to use.
|
|
* Possible values are "lookup" and "best fit"; the default is "best fit".
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* The locale matching algorithm to use.
|
|
* Possible values are "lookup" and "best fit"; the default is "best fit".
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
localeMatcher?: string;
|
|
|
|
/**
|
|
* Whether the comparison is for sorting or for searching for matching strings.
|
|
* Possible values are "sort" and "search"; the default is "sort".
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Whether the comparison is for sorting or for searching for matching strings.
|
|
* Possible values are "sort" and "search"; the default is "sort".
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Whether the comparison is for sorting or for searching for matching strings.
|
|
* Possible values are "sort" and "search"; the default is "sort".
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
usage?: string;
|
|
|
|
/**
|
|
* Which differences in the strings should lead to non-zero result values.
|
|
* Possible values are "base", "accent", "case", "variant".
|
|
* "base" are used when only strings that differ in base letters compare as unequal.
|
|
* "accent" are used when only strings that differ in base letters or accents and
|
|
* other diacritic marks compare as unequal.
|
|
* "case" are used when only strings that differ in base letters or case compare as unequal.
|
|
* "variant" are used when Strings that differ in base letters, accents and other diacritic marks,
|
|
* or case compare as unequal.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Which differences in the strings should lead to non-zero result values.
|
|
* Possible values are "base", "accent", "case", "variant".
|
|
* "base" are used when only strings that differ in base letters compare as unequal.
|
|
* "accent" are used when only strings that differ in base letters or accents and
|
|
* other diacritic marks compare as unequal.
|
|
* "case" are used when only strings that differ in base letters or case compare as unequal.
|
|
* "variant" are used when Strings that differ in base letters, accents and other diacritic marks,
|
|
* or case compare as unequal.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Which differences in the strings should lead to non-zero result values.
|
|
* Possible values are "base", "accent", "case", "variant".
|
|
* "base" are used when only strings that differ in base letters compare as unequal.
|
|
* "accent" are used when only strings that differ in base letters or accents and
|
|
* other diacritic marks compare as unequal.
|
|
* "case" are used when only strings that differ in base letters or case compare as unequal.
|
|
* "variant" are used when Strings that differ in base letters, accents and other diacritic marks,
|
|
* or case compare as unequal.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
sensitivity?: string;
|
|
|
|
/**
|
|
* Whether punctuation should be ignored. default value is false.
|
|
*
|
|
* @type { boolean }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Whether punctuation should be ignored. Default value is false.
|
|
*
|
|
* @type { ?boolean }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Whether punctuation should be ignored. Default value is false.
|
|
*
|
|
* @type { ?boolean }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
ignorePunctuation?: boolean;
|
|
|
|
/**
|
|
* Variant collations for certain locales.
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Variant collations for certain locales.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Variant collations for certain locales.
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
collation?: string;
|
|
|
|
/**
|
|
* Whether numeric collation should be used. Default value is false.
|
|
*
|
|
* @type { boolean }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Whether numeric collation should be used. Default value is false.
|
|
*
|
|
* @type { ?boolean }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Whether numeric collation should be used. Default value is false.
|
|
*
|
|
* @type { ?boolean }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
numeric?: boolean;
|
|
|
|
/**
|
|
* Whether upper case or lower case should sort first.
|
|
* Possible values are "upper", "lower", or "false" (use the locale's default).
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Whether upper case or lower case should sort first.
|
|
* Possible values are "upper", "lower", or "false" (use the locale's default).
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* Whether upper case or lower case should sort first.
|
|
* Possible values are "upper", "lower", or "false" (use the locale's default).
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
caseFirst?: string;
|
|
}
|
|
|
|
/**
|
|
* Enable language-sensitive string comparison.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Enable language-sensitive string comparison.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
export class Collator {
|
|
/**
|
|
* A constructor used to create Collator object.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* A constructor used to create Collator object.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
constructor();
|
|
/**
|
|
* A constructor used to create Collator Object;
|
|
*
|
|
* @param { string | Array<string> } locale - Indicates a character string containing the locale information, including
|
|
* the language and optionally the script and region, for the Collator object.
|
|
* @param { CollatorOptions } [options] - Indicates the options used to initialize Collator object.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* A constructor used to create Collator Object;
|
|
*
|
|
* @param { string | Array<string> } locale - Indicates a character string containing the locale information, including
|
|
* the language and optionally the script and region, for the Collator object.
|
|
* @param { CollatorOptions } [options] - Indicates the options used to initialize Collator object.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
constructor(locale: string | Array<string>, options?: CollatorOptions);
|
|
|
|
/**
|
|
* compares two strings according to the sort order of this Collator object
|
|
*
|
|
* @param { string } first - The first string to compare.
|
|
* @param { string } second - The second string to compare.
|
|
* @returns { number } a number indicating how first compare to second:
|
|
* a negative value if string1 comes before string2;
|
|
* a positive value if string1 comes after string2;
|
|
* 0 if they are considered equal.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* compares two strings according to the sort order of this Collator object
|
|
*
|
|
* @param { string } first - The first string to compare.
|
|
* @param { string } second - The second string to compare.
|
|
* @returns { number } a number indicating how first compare to second:
|
|
* a negative value if string1 comes before string2;
|
|
* a positive value if string1 comes after string2;
|
|
* 0 if they are considered equal.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
compare(first: string, second: string): number;
|
|
|
|
/**
|
|
* Returns a new object with properties that reflect the locale and collation options computed
|
|
* during initialization of the object.
|
|
*
|
|
* @returns { CollatorOptions } a CollatorOptions object with properties that reflect the properties of this object.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Returns a new object with properties that reflect the locale and collation options computed
|
|
* during initialization of the object.
|
|
*
|
|
* @returns { CollatorOptions } a CollatorOptions object with properties that reflect the properties of this object.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
resolvedOptions(): CollatorOptions;
|
|
}
|
|
|
|
/**
|
|
* Provides the options of PluralRules
|
|
*
|
|
* @interface PluralRulesOptions
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Provides the options of PluralRules
|
|
*
|
|
* @interface PluralRulesOptions
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
export interface PluralRulesOptions {
|
|
/**
|
|
* The locale matching algorithm to use.
|
|
* Possible values are "lookup" and "best fit"; the default is "best fit".
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* The locale matching algorithm to use.
|
|
* Possible values are "lookup" and "best fit"; the default is "best fit".
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* The locale matching algorithm to use.
|
|
* Possible values are "lookup" and "best fit"; the default is "best fit".
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
localeMatcher?: string;
|
|
|
|
/**
|
|
* The type to use. Possible values are: "cardinal", "ordinal"
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* The type to use. Possible values are: "cardinal", "ordinal"
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* The type to use. Possible values are: "cardinal", "ordinal"
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
type?: string;
|
|
|
|
/**
|
|
* The minimum number of integer digits to use.
|
|
* Possible values are from 1 to 21; the default is 1.
|
|
*
|
|
* @type { number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* The minimum number of integer digits to use.
|
|
* Possible values are from 1 to 21; the default is 1.
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* The minimum number of integer digits to use.
|
|
* Possible values are from 1 to 21; the default is 1.
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
minimumIntegerDigits?: number;
|
|
|
|
/**
|
|
* The minimum number of fraction digits to use.
|
|
* Possible values are from 0 to 20; the default for plain number and percent formatting is 0;
|
|
*
|
|
* @type { number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* The minimum number of fraction digits to use.
|
|
* Possible values are from 0 to 20; the default for plain number and percent formatting is 0;
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* The minimum number of fraction digits to use.
|
|
* Possible values are from 0 to 20; the default for plain number and percent formatting is 0;
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
minimumFractionDigits?: number;
|
|
|
|
/**
|
|
* The maximum number of fraction digits to use.
|
|
* Possible values are from 0 to 20;
|
|
* the default for plain number formatting is the larger of minimumFractionDigits and 3;
|
|
*
|
|
* @type { number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* The maximum number of fraction digits to use.
|
|
* Possible values are from 0 to 20;
|
|
* the default for plain number formatting is the larger of minimumFractionDigits and 3;
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* The maximum number of fraction digits to use.
|
|
* Possible values are from 0 to 20;
|
|
* the default for plain number formatting is the larger of minimumFractionDigits and 3;
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
maximumFractionDigits?: number;
|
|
|
|
/**
|
|
* The minimum number of significant digits to use.
|
|
* Possible values are from 1 to 21; the default is 1.
|
|
*
|
|
* @type { number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* The minimum number of significant digits to use.
|
|
* Possible values are from 1 to 21; the default is 1.
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* The minimum number of significant digits to use.
|
|
* Possible values are from 1 to 21; the default is 1.
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
minimumSignificantDigits?: number;
|
|
|
|
/**
|
|
* The maximum number of significant digits to use.
|
|
* Possible values are from 1 to 21; the default is 21.
|
|
*
|
|
* @type { number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* The maximum number of significant digits to use.
|
|
* Possible values are from 1 to 21; the default is 21.
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* The maximum number of significant digits to use.
|
|
* Possible values are from 1 to 21; the default is 21.
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
maximumSignificantDigits?: number;
|
|
}
|
|
|
|
/**
|
|
* Enables plural-sensitive formatting and plural-related language rules.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Enables plural-sensitive formatting and plural-related language rules.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
export class PluralRules {
|
|
/**
|
|
* A constructor used to create PluralRules object.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* A constructor used to create PluralRules object.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
constructor();
|
|
|
|
/**
|
|
* A constructor used to create PluralRules object.
|
|
*
|
|
* @param { string | Array<string> } locale - Indicates a character string containing the locale information, including
|
|
* the language and optionally the script and region, for the PluralRules object.
|
|
* @param { PluralRulesOptions } [options] - Indicates the options used to initialize PluralRules object.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* A constructor used to create PluralRules object.
|
|
*
|
|
* @param { string | Array<string> } locale - Indicates a character string containing the locale information, including
|
|
* the language and optionally the script and region, for the PluralRules object.
|
|
* @param { PluralRulesOptions } [options] - Indicates the options used to initialize PluralRules object.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
constructor(locale: string | Array<string>, options?: PluralRulesOptions);
|
|
|
|
/**
|
|
* Returns a string indicating which plural rule to use for locale-aware formatting.
|
|
*
|
|
* @param { number } n - The number to get a plural rule for.
|
|
* @returns { string } A string representing the pluralization category of the number,
|
|
* can be one of zero, one, two, few, many or other.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Returns a string indicating which plural rule to use for locale-aware formatting.
|
|
*
|
|
* @param { number } n - The number to get a plural rule for.
|
|
* @returns { string } A string representing the pluralization category of the number,
|
|
* can be one of zero, one, two, few, many or other.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
select(n: number): string;
|
|
}
|
|
|
|
/**
|
|
* Provides the input options of RelativeTimeFormat.
|
|
*
|
|
* @interface RelativeTimeFormatInputOptions
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Provides the input options of RelativeTimeFormat.
|
|
*
|
|
* @interface RelativeTimeFormatInputOptions
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
export interface RelativeTimeFormatInputOptions {
|
|
/**
|
|
* The locale matching algorithm to use.
|
|
* Possible values are: lookup, best fit
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* The locale matching algorithm to use.
|
|
* Possible values are: lookup, best fit
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* The locale matching algorithm to use.
|
|
* Possible values are: lookup, best fit
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
localeMatcher?: string;
|
|
|
|
/**
|
|
* The format of output message.
|
|
* Possible values are: always, auto
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* The format of output message.
|
|
* Possible values are: always, auto
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* The format of output message.
|
|
* Possible values are: always, auto
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
numeric?: string;
|
|
|
|
/**
|
|
* The length of the internationalized message.
|
|
* Possible values are: long, short, narrow
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* The length of the internationalized message.
|
|
* Possible values are: long, short, narrow
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 9
|
|
*/
|
|
/**
|
|
* The length of the internationalized message.
|
|
* Possible values are: long, short, narrow
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
style?: string;
|
|
}
|
|
|
|
/**
|
|
* Provides the resolved options of RelativeTimeFormat.
|
|
*
|
|
* @interface RelativeTimeFormatResolvedOptions
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Provides the resolved options of RelativeTimeFormat.
|
|
*
|
|
* @interface RelativeTimeFormatResolvedOptions
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
export interface RelativeTimeFormatResolvedOptions {
|
|
/**
|
|
* The BCP 47 language tag for the locale actually used.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* The BCP 47 language tag for the locale actually used.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
locale: string;
|
|
|
|
/**
|
|
* The length of the internationalized message.
|
|
* Possible values are: long, short, narrow
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* The length of the internationalized message.
|
|
* Possible values are: long, short, narrow
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
style: string;
|
|
|
|
/**
|
|
* The format of output message.
|
|
* Possible values are: always, auto
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* The format of output message.
|
|
* Possible values are: always, auto
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
numeric: string;
|
|
|
|
/**
|
|
* The value requested using the Unicode extension key "nu" or filled in as a default.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* The value requested using the Unicode extension key "nu" or filled in as a default.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
numberingSystem: string;
|
|
}
|
|
|
|
/**
|
|
* Given a Time period length value and a unit, RelativeTimeFormat object enables
|
|
* language-sensitive relative time formatting.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Given a Time period length value and a unit, RelativeTimeFormat object enables
|
|
* language-sensitive relative time formatting.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
export class RelativeTimeFormat {
|
|
/**
|
|
* A constructor used to create RelativeTimeFormat object.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* A constructor used to create RelativeTimeFormat object.
|
|
*
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
constructor();
|
|
|
|
/**
|
|
* A constructor used to create RelativeTimeFormat object.
|
|
*
|
|
* @param { string | Array<string> } locale - Indicates a character string containing the locale information, including
|
|
* the language and optionally the script and region, for the RelativeTimeFormat object.
|
|
* @param { RelativeTimeFormatInputOptions } [options] - Indicates the options used to initialize RelativeTimeFormat object.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* A constructor used to create RelativeTimeFormat object.
|
|
*
|
|
* @param { string | Array<string> } locale - Indicates a character string containing the locale information, including
|
|
* the language and optionally the script and region, for the RelativeTimeFormat object.
|
|
* @param { RelativeTimeFormatInputOptions } [options] - Indicates the options used to initialize RelativeTimeFormat object.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
constructor(locale: string | Array<string>, options?: RelativeTimeFormatInputOptions);
|
|
|
|
/**
|
|
* formats a value and unit according to the locale and formatting options of this object.
|
|
*
|
|
* @param { number } value - Numeric value to use in the internationalized relative time message.
|
|
* @param { string } unit - Unit to use in the relative time internationalized message.
|
|
* Possible values are: year, quarter, month, week, day, hour, minute, second.
|
|
* @returns { string } formatted language-sensitive relative time.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* formats a value and unit according to the locale and formatting options of this object.
|
|
*
|
|
* @param { number } value - Numeric value to use in the internationalized relative time message.
|
|
* @param { string } unit - Unit to use in the relative time internationalized message.
|
|
* Possible values are: year, quarter, month, week, day, hour, minute, second.
|
|
* @returns { string } formatted language-sensitive relative time.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
format(value: number, unit: string): string;
|
|
|
|
/**
|
|
* returns an Array of objects representing the relative time format in parts that can be used for
|
|
* custom locale-aware formatting
|
|
*
|
|
* @param { number } value - Numeric value to use in the internationalized relative time message.
|
|
* @param { string } unit - to use in the relative time internationalized message.
|
|
* Possible values are: year, quarter, month, week, day, hour, minute, second.
|
|
* @returns { Array<object> } an Array of objects representing the relative time format in parts
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* returns an Array of objects representing the relative time format in parts that can be used for
|
|
* custom locale-aware formatting
|
|
*
|
|
* @param { number } value - Numeric value to use in the internationalized relative time message.
|
|
* @param { string } unit - to use in the relative time internationalized message.
|
|
* Possible values are: year, quarter, month, week, day, hour, minute, second.
|
|
* @returns { Array<object> } an Array of objects representing the relative time format in parts
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
formatToParts(value: number, unit: string): Array<object>;
|
|
|
|
/**
|
|
* Returns a new object with properties that reflect the locale and formatting options computed during
|
|
* initialization of the object.
|
|
*
|
|
* @returns { RelativeTimeFormatResolvedOptions } RelativeTimeFormatOptions which reflect the locale and formatting options of the object.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @since 8
|
|
*/
|
|
/**
|
|
* Returns a new object with properties that reflect the locale and formatting options computed during
|
|
* initialization of the object.
|
|
*
|
|
* @returns { RelativeTimeFormatResolvedOptions } RelativeTimeFormatOptions which reflect the locale and formatting options of the object.
|
|
* @syscap SystemCapability.Global.I18n
|
|
* @crossplatform
|
|
* @since 10
|
|
*/
|
|
resolvedOptions(): RelativeTimeFormatResolvedOptions;
|
|
}
|
|
}
|
|
export default intl;
|