diff --git a/zh-cn/application-dev/reference/apis/js-apis-convertxml.md b/zh-cn/application-dev/reference/apis/js-apis-convertxml.md index 5fc1b021f3f85e9d2e9a55ad9fd5033695c54e6e..79ff44f13945392ad0a1eaf513af42ab0556b1c6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-convertxml.md +++ b/zh-cn/application-dev/reference/apis/js-apis-convertxml.md @@ -36,6 +36,14 @@ convertToJSObject(xml: string, options?: ConvertOptions) : Object | ------ | ---------------------------- | | Object | 处理后返回的JavaScript对象。 | +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------- | +| 10200002 | Invalid xml string. | + **示例：** ```js @@ -60,14 +68,14 @@ console.log(result); ### convert(deprecated) -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[convertToJSObject9+](#converttojsobject9)替代。 - convert(xml: string, options?: ConvertOptions) : Object 转换xml文本为JavaScript对象。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[convertToJSObject9+](#converttojsobject9)替代。 + **系统能力：** SystemCapability.Utils.Lang **参数：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-uri.md b/zh-cn/application-dev/reference/apis/js-apis-uri.md index 913a4fbde89d14be8d8c691aaf57c4d3688c5222..9ea704b72065a43343f30a0f876c7f07b9240076 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-uri.md +++ b/zh-cn/application-dev/reference/apis/js-apis-uri.md @@ -44,6 +44,14 @@ constructor是URI的构造函数。 | -------- | -------- | -------- | -------- | | uri | string | 是 | 入参对象。 | +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------- | +| 10200002 | Invalid uri string. | + **示例：** ```js @@ -79,14 +87,14 @@ result.toString() ### equals(deprecated) -> **说明：** -> -> 从API version 8开始支持，从API version 9开始废弃，建议使用[equalsTo9+](#equalsto9)替代。 - equals(other: URI): boolean 判断此URI是否与其他URI对象相等。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[equalsTo9+](#equalsto9)替代。 + **系统能力：** SystemCapability.Utils.Lang **参数：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-url.md b/zh-cn/application-dev/reference/apis/js-apis-url.md index 1631975c83e59f66b58b748b0d2327d3e9a7170d..48b14dd8f0c07838cd991280880b394d0ef23992 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-url.md +++ b/zh-cn/application-dev/reference/apis/js-apis-url.md @@ -366,18 +366,148 @@ params.append('fod', '3'); console.log(params.toString()); ``` -## URLSearchParams(deprecated) +## URL + +### 属性 + +**系统能力：** 以下各项对应的系统能力均为SystemCapability.Utils.Lang + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| hash | string | 是 | 是 | 获取和设置URL的片段部分。 | +| host | string | 是 | 是 | 获取和设置URL的主机部分。 | +| hostname | string | 是 | 是 | 获取和设置URL的主机名部分，不带端口。 | +| href | string | 是 | 是 | 获取和设置序列化的URL。 | +| origin | string | 是 | 否 | 获取URL源的只读序列化。 | +| password | string | 是 | 是 | 获取和设置URL的密码部分。 | +| pathname | string | 是 | 是 | 获取和设置URL的路径部分。 | +| port | string | 是 | 是 | 获取和设置URL的端口部分。 | +| protocol | string | 是 | 是 | 获取和设置URL的协议部分。 | +| search | string | 是 | 是 | 获取和设置URL的序列化查询部分。 | +| searchParams | URLSearchParams | 是 | 否 | 获取URLSearchParams表示URL查询参数的对象。 | +| URLParams | URLParams | 是 | 否 | 获取URLParams表示URL查询参数的对象。 | +| username | string | 是 | 是 | 获取和设置URL的用户名部分。 | ### constructor(deprecated) +constructor(url: string, base?: string | URL) + +URL的构造函数。 + > **说明：** > -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+](#constructor9+)替代。 +> 从API version 7开始支持，从API version 9开始废弃，建议使用[parseURL9+](#parseurl9)替代。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| url | string | 是 | 入参对象。 | +| base | string \| URL | 否 | 入参字符串或者对象。
- string：字符串
- URL：字符串或对象 | + +**示例：** + +```js +let mm = 'http://username:password@host:8080'; +let a = new Url.URL("/", mm); // Output 'http://username:password@host:8080/'; +let b = new Url.URL(mm); // Output 'http://username:password@host:8080/'; +new Url.URL('path/path1', b); // Output 'http://username:password@host:8080/path/path1'; +let c = new Url.URL('/path/path1', b); // Output 'http://username:password@host:8080/path/path1'; +new Url.URL('/path/path1', c); // Output 'http://username:password@host:8080/path/path1'; +new Url.URL('/path/path1', a); // Output 'http://username:password@host:8080/path/path1'; +new Url.URL('/path/path1', "https://www.exampleUrl/fr-FR/toto"); // Output https://www.exampleUrl/path/path1 +new Url.URL('/path/path1', ''); // Raises a TypeError exception as '' is not a valid URL +new Url.URL('/path/path1'); // Raises a TypeError exception as '/path/path1' is not a valid URL +new Url.URL('https://www.example.com', ); // Output https://www.example.com/ +new Url.URL('https://www.example.com', b); // Output https://www.example.com/ +``` + +### parseURL9+ + +static parseURL(url : string, base?: string | URL): URL + +URL静态成员函数。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| url | string | 是 | 入参对象。 | +| base | string \| URL | 否 | 入参字符串或者对象。
- string：字符串
- URL：字符串或对象 | + +**错误码：** + +以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)。 + +| 错误码ID | 错误信息 | +| -------- | -------- | +| 10200002 | Invalid url string. | + +**示例：** + +```js +let mm = 'http://username:password@host:8080'; +Url.URL.parseURL(mm); // Output 'http://username:password@host:8080/'; +``` + +### tostring + +toString(): string + +将解析过后的URL转化为字符串。 + +**系统能力：** SystemCapability.Utils.Lang + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| string | 用于返回网址的字符串序列化。 | + +**示例：** + +```js +const url = new Url.URL('http://username:password@host:8080/directory/file?query=pppppp#qwer=da'); +url.toString(); +``` + + +### toJSON + +toJSON(): string + +将解析过后的URL转化为JSON字符串。 + +**系统能力：** SystemCapability.Utils.Lang + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| string | 用于返回网址的字符串序列化。 | + +**示例：** +```js +const url = new Url.URL('http://username:password@host:8080/directory/file?query=pppppp#qwer=da'); +url.toJSON(); +``` + +## URLSearchParams(deprecated) + +### constructor(deprecated) constructor(init?: string[][] | Record<string, string> | string | URLSearchParams) URLSearchParams的构造函数。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+](#constructor9)替代。 + **系统能力：** SystemCapability.Utils.Lang **参数：** @@ -398,14 +528,14 @@ let params = new Url.URLSearchParams(urlObject.search); ### append(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.append9+](#append9)替代。 - append(name: string, value: string): void 将新的键值对插入到查询字符串。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.append9+](#append9)替代。 + **系统能力：** SystemCapability.Utils.Lang **参数：** @@ -425,14 +555,14 @@ paramsObject.append('fod', '3'); ### delete(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.delete9+](#delete9)替代。 - delete(name: string): void 删除指定名称的键值对。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.delete9+](#delete9)替代。 + **系统能力：** SystemCapability.Utils.Lang **参数：** @@ -451,14 +581,14 @@ paramsobject.delete('fod'); ### getAll(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.getAll9+](#getall9)替代。 - getAll(name: string): string[] 获取指定名称的所有键值对。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.getAll9+](#getall9)替代。 + **系统能力：** SystemCapability.Utils.Lang **参数：** @@ -484,14 +614,14 @@ console.log(params.getAll('fod').toString()) // Output ["1","3"]. ### entries(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.entries9+](#entries9)替代。 - entries(): IterableIterator<[string, string]> 返回一个ES6的迭代器，迭代器的每一项都是一个 JavaScript Array。Array的第一项是name，Array的第二项是value。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.entries9+](#entries9)替代。 + **系统能力：** SystemCapability.Utils.Lang **返回值：** @@ -511,14 +641,15 @@ for (var pair of searchParamsObject .entries()) { // Show keyName/valueName pair ### forEach(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.forEach9+](#foreach9)替代。 forEach(callbackFn: (value: string, key: string, searchParams: this) => void, thisArg?: Object): void 通过回调函数来遍历URLSearchParams实例对象上的键值对。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.forEach9+](#foreach9)替代。 + **系统能力：** SystemCapability.Utils.Lang **参数：** @@ -547,14 +678,15 @@ myURLObject.searchParams.forEach((value, name, searchParams) => { ### get(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.get9+](#get9)替代。 get(name: string): string | null 获取指定名称对应的第一个值。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.get9+](#get9)替代。 + **系统能力：** SystemCapability.Utils.Lang **参数：** @@ -580,14 +712,15 @@ let age = parseInt(paramsObject.get("age"), 10); // is the number 18 ### has(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.has9+](#has9)替代。 has(name: string): boolean 判断一个指定的键名对应的值是否存在。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.has9+](#has9)替代。 + **系统能力：** SystemCapability.Utils.Lang **参数：** @@ -612,14 +745,15 @@ paramsObject.has('bard') === true; ### set(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.set9+](#set9)替代。 set(name: string, value: string): void 将与name关联的URLSearchParams对象中的值设置为value。如果存在名称为name的键值对，请将第一个键值对的值设置为value并删除所有其他值。如果不是，则将键值对附加到查询字符串。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.set9+](#set9)替代。 + **系统能力：** SystemCapability.Utils.Lang **参数：** @@ -639,14 +773,15 @@ paramsObject.set('baz', '3'); // Add a third parameter. ### sort(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.sort9+](#sort9)替代。 sort(): void 对包含在此对象中的所有键值对进行排序，并返回undefined。排序顺序是根据键的Unicode代码点。该方法使用稳定的排序算法 （即，将保留具有相等键的键值对之间的相对顺序）。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.sort9+](#sort9)替代。 + **系统能力：** SystemCapability.Utils.Lang **示例：** @@ -659,14 +794,15 @@ console.log(searchParamsObject.toString()); // Display the sorted query string / ### keys(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.keys9+](#keys9)替代。 keys(): IterableIterator<string> 返回一个所有键值对的name的ES6迭代器。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.keys9+](#keys9)替代。 + **系统能力：** SystemCapability.Utils.Lang **返回值：** @@ -686,14 +822,15 @@ for (var key of searchParamsObject .keys()) { // Output key-value pairs ### values(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.values9+](#values9)替代。 values(): IterableIterator<string> 返回一个所有键值对的value的ES6迭代器。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams9+.values9+](#values9)替代。 + **系统能力：** SystemCapability.Utils.Lang **返回值：** @@ -714,14 +851,14 @@ for (var value of searchParams.values()) { ### [Symbol.iterator](deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[[Symbol.iterator]9+](#symboliterator9)替代。 - [Symbol.iterator]\(): IterableIterator<[string, string]> 返回一个ES6的迭代器，迭代器的每一项都是一个 JavaScript Array。Array的第一项是name，Array的第二项是value。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[[Symbol.iterator]9+](#symboliterator9)替代。 + **系统能力：** SystemCapability.Utils.Lang **返回值：** @@ -740,14 +877,15 @@ for (const [name, value] of paramsObject) { ``` ### tostring(deprecated) -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[tostring9+](#tostring9)替代。 toString(): string 返回序列化为字符串的搜索参数，必要时对字符进行百分比编码。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[tostring9+](#tostring9)替代。 + **系统能力：** SystemCapability.Utils.Lang **返回值：** @@ -764,126 +902,4 @@ let params = new Url.URLSearchParams(url.search.slice(1)); params.append('fod', '3'); console.log(params.toString()); ``` - -## URL - -### 属性 - -**系统能力：** 以下各项对应的系统能力均为SystemCapability.Utils.Lang - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| -------- | -------- | -------- | -------- | -------- | -| hash | string | 是 | 是 | 获取和设置URL的片段部分。 | -| host | string | 是 | 是 | 获取和设置URL的主机部分。 | -| hostname | string | 是 | 是 | 获取和设置URL的主机名部分，不带端口。 | -| href | string | 是 | 是 | 获取和设置序列化的URL。 | -| origin | string | 是 | 否 | 获取URL源的只读序列化。 | -| password | string | 是 | 是 | 获取和设置URL的密码部分。 | -| pathname | string | 是 | 是 | 获取和设置URL的路径部分。 | -| port | string | 是 | 是 | 获取和设置URL的端口部分。 | -| protocol | string | 是 | 是 | 获取和设置URL的协议部分。 | -| search | string | 是 | 是 | 获取和设置URL的序列化查询部分。 | -| searchParams | URLSearchParams | 是 | 否 | 获取URLSearchParams表示URL查询参数的对象。 | -| URLParams | URLParams | 是 | 否 | 获取URLParams表示URL查询参数的对象。 | -| username | string | 是 | 是 | 获取和设置URL的用户名部分。 | - -### constructor(deprecated) - -> **说明：** -> -> 从API version 7开始支持，从API version 9开始废弃，建议使用[parseURL9+](#parseurl9)替代。 - -constructor(url: string, base?: string | URL) - -URL的构造函数。 - -**系统能力：** SystemCapability.Utils.Lang - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| url | string | 是 | 入参对象。 | -| base | string \| URL | 否 | 入参字符串或者对象。
- string：字符串
- URL：字符串或对象 | - -**示例：** - -```js -let mm = 'http://username:password@host:8080'; -let a = new Url.URL("/", mm); // Output 'http://username:password@host:8080/'; -let b = new Url.URL(mm); // Output 'http://username:password@host:8080/'; -new Url.URL('path/path1', b); // Output 'http://username:password@host:8080/path/path1'; -let c = new Url.URL('/path/path1', b); // Output 'http://username:password@host:8080/path/path1'; -new Url.URL('/path/path1', c); // Output 'http://username:password@host:8080/path/path1'; -new Url.URL('/path/path1', a); // Output 'http://username:password@host:8080/path/path1'; -new Url.URL('/path/path1', "https://www.exampleUrl/fr-FR/toto"); // Output https://www.exampleUrl/path/path1 -new Url.URL('/path/path1', ''); // Raises a TypeError exception as '' is not a valid URL -new Url.URL('/path/path1'); // Raises a TypeError exception as '/path/path1' is not a valid URL -new Url.URL('https://www.example.com', ); // Output https://www.example.com/ -new Url.URL('https://www.example.com', b); // Output https://www.example.com/ -``` - -### parseURL9+ - -static parseURL(url : string, base?: string | URL): URL - -URL静态成员函数。 - -**系统能力：** SystemCapability.Utils.Lang - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| url | string | 是 | 入参对象。 | -| base | string \| URL | 否 | 入参字符串或者对象。
- string：字符串
- URL：字符串或对象 | - -**示例：** - -```js -let mm = 'http://username:password@host:8080'; -Url.URL.parseURL(mm); // Output 'http://username:password@host:8080/'; -``` - -### tostring - -toString(): string - -将解析过后的URL转化为字符串。 - -**系统能力：** SystemCapability.Utils.Lang - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| string | 用于返回网址的字符串序列化。 | - -**示例：** - -```js -const url = new Url.URL('http://username:password@host:8080/directory/file?query=pppppp#qwer=da'); -url.toString(); -``` - - -### toJSON - -toJSON(): string - -将解析过后的URL转化为JSON字符串。 - -**系统能力：** SystemCapability.Utils.Lang - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| string | 用于返回网址的字符串序列化。 | - -**示例：** -```js -const url = new Url.URL('http://username:password@host:8080/directory/file?query=pppppp#qwer=da'); -url.toJSON(); -``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-util.md b/zh-cn/application-dev/reference/apis/js-apis-util.md index 62089429db66513f63bcc02031b046ab87be3d37..22d452bd58275864cd5ec33c14f04ce56c683b22 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-util.md +++ b/zh-cn/application-dev/reference/apis/js-apis-util.md @@ -41,38 +41,6 @@ let res = util.format("%s", "hello world!"); console.log(res); ``` -## util.printf(deprecated) - -printf(format: string, ...args: Object[]): string - -通过式样化字符串对输入的内容按特定格式输出。 - -> **说明：** -> -> 从API Version 7开始支持，从API Version 9开始废弃，建议使用[util.format9+](#utilformat9)替代。 - -**系统能力：** SystemCapability.Utils.Lang - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| format | string | 是 | 式样化字符串。 | -| ...args | Object[] | 否 | 替换式样化字符串通配符的数据。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| string | 按特定格式式样化后的字符串。 | - -**示例：** - - ```js - let res = util.printf("%s", "hello world!"); - console.log(res); - ``` - ## util.errnoToString9+ errnoToString(errno: number): string @@ -101,38 +69,6 @@ let result = util.errnoToString(errnum); console.log("result = " + result); ``` -## util.getErrorString(deprecated) - -getErrorString(errno: number): string - -获取系统错误码对应的详细信息。 - -> **说明：** -> -> 从API Version 7开始支持，从API Version 9开始废弃，建议使用[util.errnoToString9+](#utilerrnotostring9)替代。 - -**系统能力：** SystemCapability.Utils.Lang - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| errno | number | 是 | 系统发生错误产生的错误码。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| string | 错误码对应的详细信息。 | - -**示例：** - - ```js - let errnum = 10; // 10 : a system error number - let result = util.getErrorString(errnum); - console.log("result = " + result); - ``` - ## util.callbackWrapper callbackWrapper(original: Function): (err: Object, value: Object )=>void @@ -203,30 +139,6 @@ promisify(original: (err: Object, value: Object) => void): Function }) ``` -## util.promiseWrapper(deprecated) - -promiseWrapper(original: (err: Object, value: Object) => void): Object - -对异步函数处理并返回一个promise的版本。 - -> **说明：** -> -> 此接口不可用，建议使用[util.promisify9+](#utilpromisify9)替代。 - -**系统能力：** SystemCapability.Utils.Lang - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| original | Function | 是 | 异步函数。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| Function | 采用遵循常见的错误优先的回调风格的函数（也就是将 (err, value) => ... 回调作为最后一个参数），并返回一个返回 promise 的版本。 | - ## util.randomUUID9+ randomUUID(entropyCache?: boolean): string @@ -314,6 +226,96 @@ parseUUID(uuid: string): Uint8Array // 132,189,247,150,102,204,70,85,155,137,214,33,141,16,15,156 ``` +## util.printf(deprecated) + +printf(format: string, ...args: Object[]): string + +通过式样化字符串对输入的内容按特定格式输出。 + +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[util.format9+](#utilformat9)替代。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| format | string | 是 | 式样化字符串。 | +| ...args | Object[] | 否 | 替换式样化字符串通配符的数据。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| string | 按特定格式式样化后的字符串。 | + +**示例：** + + ```js + let res = util.printf("%s", "hello world!"); + console.log(res); + ``` + + +## util.getErrorString(deprecated) + +getErrorString(errno: number): string + +获取系统错误码对应的详细信息。 + +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[util.errnoToString9+](#utilerrnotostring9)替代。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| errno | number | 是 | 系统发生错误产生的错误码。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| string | 错误码对应的详细信息。 | + +**示例：** + + ```js + let errnum = 10; // 10 : a system error number + let result = util.getErrorString(errnum); + console.log("result = " + result); + ``` + +## util.promiseWrapper(deprecated) + +promiseWrapper(original: (err: Object, value: Object) => void): Object + +对异步函数处理并返回一个promise的版本。 + +> **说明：** +> +> 此接口不可用，建议使用[util.promisify9+](#utilpromisify9)替代。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| original | Function | 是 | 异步函数。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| Function | 采用遵循常见的错误优先的回调风格的函数（也就是将 (err, value) => ... 回调作为最后一个参数），并返回一个返回 promise 的版本。 | + + ## TextDecoder ### 属性 @@ -363,38 +365,6 @@ let textDecoder = new util.TextDecoder() textDecoder.create('utf-8', { ignoreBOM : true }); ``` -### constructor(deprecated) - -constructor(encoding?: string, options?: { fatal?: boolean; ignoreBOM?: boolean },) - -TextDecoder的构造函数。 - -> **说明：** -> -> 从API Version 7开始支持，从API Version 9开始废弃，建议使用[constructor9+](#constructor9)替代。 - -**系统能力：** SystemCapability.Utils.Lang - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| encoding | string | 否 | 编码格式。 | -| options | Object | 否 | 编码相关选项参数，存在两个属性fatal和ignoreBOM。 | - - **表1** options - -| 名称 | 参数类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| fatal | boolean | 否 | 是否显示致命错误。 | -| ignoreBOM | boolean | 否 | 是否忽略BOM标记。 | - -**示例：** - - ```js - let textDecoder = new util.TextDecoder("utf-8",{ignoreBOM: true}); - ``` - ### decode decode(input: Uint8Array, options?: { stream?: false }): string @@ -482,6 +452,37 @@ decodeWithStream(input: Uint8Array, options?: { stream?: boolean }): string console.log("retStr = " + retStr); ``` +### constructor(deprecated) + +constructor(encoding?: string, options?: { fatal?: boolean; ignoreBOM?: boolean },) + +TextDecoder的构造函数。 + +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[constructor9+](#constructor9)替代。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| encoding | string | 否 | 编码格式。 | +| options | Object | 否 | 编码相关选项参数，存在两个属性fatal和ignoreBOM。 | + + **表1** options + +| 名称 | 参数类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| fatal | boolean | 否 | 是否显示致命错误。 | +| ignoreBOM | boolean | 否 | 是否忽略BOM标记。 | + +**示例：** + + ```js + let textDecoder = new util.TextDecoder("utf-8",{ignoreBOM: true}); + ``` ## TextEncoder @@ -537,78 +538,80 @@ let result = new Uint8Array(buffer); result = textEncoder.encodeInto("\uD800¥¥"); ``` -### encode(deprecated) - -encode(input?: string): Uint8Array +### encodeIntoUint8Array9+ -通过输入参数编码后输出对应文本。 +encodeIntoUint8Array(input: string, dest: Uint8Array, ): { read: number; written: number } -> **说明：** -> -> 从API Version 7开始支持，从API Version 9开始废弃，建议使用[encodeInto9+](#encodeinto9)替代。 +放置生成的UTF-8编码文本。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| input | string | 否 | 需要编码的字符串。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ---------- | ---- | ------------------------------------------------------- | +| input | string | 是 | 需要编码的字符串。 | +| dest | Uint8Array | 是 | Uint8Array对象实例，用于将生成的UTF-8编码文本放入其中。 | **返回值：** -| 类型 | 说明 | -| -------- | -------- | +| 类型 | 说明 | +| ---------- | ------------------ | | Uint8Array | 返回编码后的文本。 | **示例：** + ```js - let textEncoder = new util.TextEncoder(); - let buffer = new ArrayBuffer(20); - let result = new Uint8Array(buffer); - result = textEncoder.encode("\uD800¥¥"); +let that = new util.TextEncoder() +let buffer = new ArrayBuffer(4) +let dest = new Uint8Array(buffer) +let result = new Object() +result = that.encodeInto('abcd', dest) ``` -### encodeIntoUint8Array9+ +### encodeInto(deprecated) -encodeIntoUint8Array(input: string, dest: Uint8Array, ): { read: number; written: number } +encodeInto(input: string, dest: Uint8Array, ): { read: number; written: number } 放置生成的UTF-8编码文本。 +> **说明：** +> +> 从API version 7开始支持，从API version 9开始废弃，建议使用[encodeIntoUint8Array9+](#encodeintouint8array9)替代。 + **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---------- | ---- | ------------------------------------------------------- | -| input | string | 是 | 需要编码的字符串。 | -| dest | Uint8Array | 是 | Uint8Array对象实例，用于将生成的UTF-8编码文本放入其中。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| input | string | 是 | 需要编码的字符串。 | +| dest | Uint8Array | 是 | Uint8Array对象实例，用于将生成的UTF-8编码文本放入其中。 | **返回值：** -| 类型 | 说明 | -| ---------- | ------------------ | +| 类型 | 说明 | +| -------- | -------- | | Uint8Array | 返回编码后的文本。 | **示例：** - ```js -let that = new util.TextEncoder() -let buffer = new ArrayBuffer(4) -let dest = new Uint8Array(buffer) -let result = new Object() -result = that.encodeInto('abcd', dest) + let that = new util.TextEncoder() + let buffer = new ArrayBuffer(4) + let dest = new Uint8Array(buffer) + let result = new Object() + result = that.encodeInto('abcd', dest) ``` -### encodeInto(deprecated) +### encode(deprecated) -encodeInto(input: string, dest: Uint8Array, ): { read: number; written: number } +encode(input?: string): Uint8Array -放置生成的UTF-8编码文本。 +通过输入参数编码后输出对应文本。 > **说明：** > -> 从API Version 7开始支持，从API Version 9开始废弃，建议使用[encodeIntoUint8Array9+](#encodeintouint8array9)替代。 +> 从API version 7开始支持，从API version 9开始废弃，建议使用[encodeInto9+](#encodeinto9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -616,8 +619,7 @@ encodeInto(input: string, dest: Uint8Array, ): { read: number; written: number } | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| input | string | 是 | 需要编码的字符串。 | -| dest | Uint8Array | 是 | Uint8Array对象实例，用于将生成的UTF-8编码文本放入其中。 | +| input | string | 否 | 需要编码的字符串。 | **返回值：** @@ -627,11 +629,10 @@ encodeInto(input: string, dest: Uint8Array, ): { read: number; written: number } **示例：** ```js - let that = new util.TextEncoder() - let buffer = new ArrayBuffer(4) - let dest = new Uint8Array(buffer) - let result = new Object() - result = that.encodeInto('abcd', dest) + let textEncoder = new util.TextEncoder(); + let buffer = new ArrayBuffer(20); + let result = new Uint8Array(buffer); + result = textEncoder.encode("\uD800¥¥"); ``` ## RationalNumber8+ @@ -671,31 +672,6 @@ parseRationalNumber(numerator: number,denominator: number): RationalNumber let rationalNumber = util.RationalNumber.parseRationalNumber(1,2) ``` -### constructor(deprecated) - -constructor(numerator: number,denominator: number) - -RationalNumber的构造函数。 - -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[constructor9+](#constructor9)替代。 - -**系统能力：** SystemCapability.Utils.Lang - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| numerator | number | 是 | 分子，整数类型。 | -| denominator | number | 是 | 分母，整数类型。 | - -**示例：** - -```js -let rationalNumber = new util.RationalNumber(1,2); -``` - ### createRationalFromString8+ static createRationalFromString​(rationalString: string): RationalNumber​ @@ -751,38 +727,6 @@ let rational = util.RationalNumber.createRationalFromString("3/4"); let result = rationalNumber.compare(rational); ``` -### compareTo(deprecated) - -compareTo​(another: RationalNumber): number​ - -将当前的RationalNumber对象与给定的对象进行比较。 - -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[compare9+](#compare9)替代。 - -**系统能力：** SystemCapability.Utils.Lang - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| another | RationalNumber | 是 | 其他的有理数对象。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| number | 如果两个对象相等，则返回0；如果给定对象小于当前对象，则返回1；如果给定对象大于当前对象，则返回-1。 | - -**示例：** - -```js -let rationalNumber = new util.RationalNumber(1,2); -let rational = util.RationalNumber.createRationalFromString("3/4"); -let result = rationalNumber.compareTo(rational); -``` - ### valueOf8+ valueOf(): number @@ -860,38 +804,6 @@ let rationalNumber = new util.RationalNumber(1,2); let result = util.RationalNumber.getCommonFactor(4,6); ``` -### getCommonDivisor(deprecated) - -static getCommonDivisor​(number1: number,number2: number): number - -获取两个指定整数的最大公约数。 - -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[getCommonFactor9+](#getcommonfactor9)替代。 - -**系统能力：** SystemCapability.Utils.Lang - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| number1 | number | 是 | 整数类型。 | -| number2 | number | 是 | 整数类型。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| number | 返回两个给定数字的最大公约数。 | - -**示例：** - -```js -let rationalNumber = new util.RationalNumber(1,2); -let result = util.RationalNumber.getCommonDivisor(4,6); -``` - ### getNumerator8+ getNumerator​(): number @@ -1018,6 +930,94 @@ let rationalNumber = new util.RationalNumber(1,2); let result = rationalNumber.toString(); ``` +### constructor(deprecated) + +constructor(numerator: number,denominator: number) + +RationalNumber的构造函数。 + +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[constructor9+](#constructor9)替代。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| numerator | number | 是 | 分子，整数类型。 | +| denominator | number | 是 | 分母，整数类型。 | + +**示例：** + +```js +let rationalNumber = new util.RationalNumber(1,2); +``` + +### compareTo(deprecated) + +compareTo​(another: RationalNumber): number​ + +将当前的RationalNumber对象与给定的对象进行比较。 + +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[compare9+](#compare9)替代。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| another | RationalNumber | 是 | 其他的有理数对象。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| number | 如果两个对象相等，则返回0；如果给定对象小于当前对象，则返回1；如果给定对象大于当前对象，则返回-1。 | + +**示例：** + +```js +let rationalNumber = new util.RationalNumber(1,2); +let rational = util.RationalNumber.createRationalFromString("3/4"); +let result = rationalNumber.compareTo(rational); +``` + +### getCommonDivisor(deprecated) + +static getCommonDivisor​(number1: number,number2: number): number + +获取两个指定整数的最大公约数。 + +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[getCommonFactor9+](#getcommonfactor9)替代。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| number1 | number | 是 | 整数类型。 | +| number2 | number | 是 | 整数类型。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| number | 返回两个给定数字的最大公约数。 | + +**示例：** + +```js +let rationalNumber = new util.RationalNumber(1,2); +let result = util.RationalNumber.getCommonDivisor(4,6); +``` ## LRUCache9+ @@ -1564,1026 +1564,987 @@ pro.put(2,10); let result = pro[Symbol.iterator](); ``` -## LruBuffer(deprecated) -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[LRUCache9+](#lrucache9)替代。 +## ScopeHelper9+ -### 属性 +### constructor9+ -**系统能力：** 以下各项对应的系统能力均为SystemCapability.Utils.Lang。 +constructor(lowerObj: ScopeType, upperObj: ScopeType) -| 名称 | 类型 | 可读 | 可写 | 说明 | -| -------- | -------- | -------- | -------- | -------- | -| length | number | 是 | 否 | 当前缓冲区中值的总数。 | +用于创建指定下限和上限的作用域实例的构造函数，返回一个ScopeHelper对象。 + +**系统能力：** SystemCapability.Utils.Lang + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------ | ---- | ---------------------- | +| lowerObj | [ScopeType](#scopetype8) | 是 | 指定作用域实例的下限。 | +| upperObj | [ScopeType](#scopetype8) | 是 | 指定作用域实例的上限。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - pro.put(1,8); - let result = pro.length; +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let range = new util.ScopeHelper(tempLower, tempUpper); ``` -### constructor(deprecated) -constructor(capacity?: number) +### toString9+ -默认构造函数用于创建一个新的LruBuffer实例，默认容量为64。 +toString(): string -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[constructor9+](#constructor9)替代。 +该字符串化方法返回一个包含当前范围的字符串表示形式。 **系统能力：** SystemCapability.Utils.Lang -**参数：** +**返回值：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| capacity | number | 否 | 指示要为缓冲区自定义的容量。 | +| 类型 | 说明 | +| ------ | -------------------------------------- | +| string | 返回包含当前范围对象的字符串表示形式。 | **示例：** ```js - let lrubuffer= new util.LruBuffer(); +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let range = new util.ScopeHelper(tempLower, tempUpper); +let result = range.toString(); ``` -### updateCapacity(deprecated) -updateCapacity(newCapacity: number): void +### intersect9+ -将缓冲区容量更新为指定容量，如果newCapacity小于或等于0，则抛出异常。 +intersect(range: ScopeHelper): ScopeHelper -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[updateCapacity9+](#updatecapacity9)替代。 +获取给定范围和当前范围的交集。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| newCapacity | number | 是 | 指示要为缓冲区自定义的容量。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ---------------------------- | ---- | ------------------ | +| range | [ScopeHelper](#scopehelper9) | 是 | 传入一个给定范围。 | + +**返回值：** + +| 类型 | 说明 | +| ------------------------------ | ------------------------------ | +| [ScopeHelper9+](#scopehelper9) | 返回给定范围和当前范围的交集。 | **示例：** ```js - let pro = new util.LruBuffer(); - let result = pro.updateCapacity(100); +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let range = new util.ScopeHelper(tempLower, tempUpper); +let tempMiDF = new Temperature(35); +let tempMidS = new Temperature(39); +let rangeFir = new util.ScopeHelper(tempMiDF, tempMidS); +range.intersect(rangeFir ); ``` -### toString(deprecated) -toString(): string +### intersect9+ -返回对象的字符串表示形式。 +intersect(lowerObj:ScopeType,upperObj:ScopeType):ScopeHelper -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[toString9+](#tostring9)替代。 +获取当前范围与给定下限和上限范围的交集。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------ | ---- | ---------------- | +| lowerObj | [ScopeType](#scopetype8) | 是 | 给定范围的下限。 | +| upperObj | [ScopeType](#scopetype8) | 是 | 给定范围的上限。 | + **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| string | 返回对象的字符串表示形式。 | +| 类型 | 说明 | +| ---------------------------- | ---------------------------------------- | +| [ScopeHelper](#scopehelper9) | 返回当前范围与给定下限和上限范围的交集。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - pro.get(2); - pro.remove(20); - let result = pro.toString(); +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let tempMiDF = new Temperature(35); +let tempMidS = new Temperature(39); +let range = new util.ScopeHelper(tempLower, tempUpper); +let result = range.intersect(tempMiDF, tempMidS); ``` -### getCapacity(deprecated) -getCapacity(): number +### getUpper9+ -获取当前缓冲区的容量。 +getUpper(): ScopeType -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[getCapacity9+](#getcapacity9)替代。 +获取当前范围的上限。 **系统能力：** SystemCapability.Utils.Lang **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| number | 返回当前缓冲区的容量。 | +| 类型 | 说明 | +| ------------------------ | ---------------------- | +| [ScopeType](#scopetype8) | 返回当前范围的上限值。 | **示例：** + ```js - let pro = new util.LruBuffer(); - let result = pro.getCapacity(); +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let range = new util.ScopeHelper(tempLower, tempUpper); +let result = range.getUpper(); ``` -### clear(deprecated) -clear(): void +### getLower9+ -从当前缓冲区清除键值对。后续会调用afterRemoval()方法执行后续操作。 +getLower(): ScopeType -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[clear9+](#clear9)替代。 +获取当前范围的下限。 **系统能力：** SystemCapability.Utils.Lang +**返回值：** + +| 类型 | 说明 | +| ------------------------ | ---------------------- | +| [ScopeType](#scopetype8) | 返回当前范围的下限值。 | + **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - let result = pro.length; - pro.clear(); +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let range = new util.ScopeHelper(tempLower, tempUpper); +let result = range.getLower(); ``` -### getCreateCount(deprecated) -getCreateCount(): number +### expand9+ -获取createDefault()返回值的次数。 +expand(lowerObj: ScopeType,upperObj: ScopeType): ScopeHelper -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[getCreateCount9+](#getcreatecount9)替代。 +创建并返回包括当前范围和给定下限和上限的并集。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------ | ---- | ---------------- | +| lowerObj | [ScopeType](#scopetype8) | 是 | 给定范围的下限。 | +| upperObj | [ScopeType](#scopetype8) | 是 | 给定范围的上限。 | + **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| number | 返回createDefault()返回值的次数。 | +| 类型 | 说明 | +| ---------------------------- | ------------------------------------ | +| [ScopeHelper](#scopehelper9) | 返回当前范围和给定下限和上限的并集。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(1,8); - let result = pro.getCreateCount(); +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let tempMiDF = new Temperature(35); +let tempMidS = new Temperature(39); +let range = new util.ScopeHelper(tempLower, tempUpper); +let result = range.expand(tempMiDF, tempMidS); ``` -### getMissCount(deprecated) -getMissCount(): number +### expand9+ -获取查询值不匹配的次数。 +expand(range: ScopeHelper): ScopeHelper -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[getMissCount9+](#getmisscount9)替代。 +创建并返回包括当前范围和给定范围的并集。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ---------------------------- | ---- | ------------------ | +| range | [ScopeHelper](#scopehelper9) | 是 | 传入一个给定范围。 | + **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| number | 返回查询值不匹配的次数。 | +| 类型 | 说明 | +| ---------------------------- | ---------------------------------- | +| [ScopeHelper](#scopehelper9) | 返回包括当前范围和给定范围的并集。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - pro.get(2); - let result = pro.getMissCount(); +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let tempMiDF = new Temperature(35); +let tempMidS = new Temperature(39); +let range = new util.ScopeHelper(tempLower, tempUpper); +let rangeFir = new util.ScopeHelper(tempMiDF, tempMidS); +let result = range.expand(rangeFir); ``` -### getRemovalCount(deprecated) -getRemovalCount(): number +### expand9+ -获取从缓冲区中逐出值的次数。 +expand(value: ScopeType): ScopeHelper -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[getRemovalCount9+](#getremovalcount9)替代。 +创建并返回包括当前范围和给定值的并集。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------------ | ---- | ---------------- | +| value | [ScopeType](#scopetype8) | 是 | 传入一个给定值。 | + **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| number | 返回从缓冲区中驱逐的次数。 | +| 类型 | 说明 | +| ---------------------------- | -------------------------------- | +| [ScopeHelper](#scopehelper9) | 返回包括当前范围和给定值的并集。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - pro.updateCapacity(2); - pro.put(50,22); - let result = pro.getRemovalCount(); +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let tempMiDF = new Temperature(35); +let range = new util.ScopeHelper(tempLower, tempUpper); +let result = range.expand(tempMiDF); ``` -### getMatchCount(deprecated) -getMatchCount(): number +### contains9+ -获取查询值匹配成功的次数。 +contains(value: ScopeType): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[getMatchCount9+](#getmatchcount9)替代。 +检查给定value是否包含在当前范围内。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------------ | ---- | ---------------- | +| value | [ScopeType](#scopetype8) | 是 | 传入一个给定值。 | + **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| number | 返回查询值匹配成功的次数。 | +| 类型 | 说明 | +| ------- | --------------------------------------------------- | +| boolean | 如果给定值包含在当前范围内返回true，否则返回false。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - pro.get(2); - let result = pro.getMatchCount(); +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let tempMiDF = new Temperature(35); +let range = new util.ScopeHelper(tempLower, tempUpper); +range.contains(tempMiDF); ``` -### getPutCount(deprecated) -getPutCount(): number +### contains9+ -获取将值添加到缓冲区的次数。 +contains(range: ScopeHelper): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[getPutCount9+](#getputcount9)替代。 +检查给定range是否在当前范围内。 **系统能力：** SystemCapability.Utils.Lang -**返回值：** +**参数：** -| 类型 | 说明 | -| -------- | -------- | -| number | 返回将值添加到缓冲区的次数。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ---------------------------- | ---- | ------------------ | +| range | [ScopeHelper](#scopehelper9) | 是 | 传入一个给定范围。 | + +**返回值：** + +| 类型 | 说明 | +| ------- | ----------------------------------------------------- | +| boolean | 如果给定范围包含在当前范围内返回true，否则返回false。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - let result = pro.getPutCount(); +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let range = new util.ScopeHelper(tempLower, tempUpper); +let tempLess = new Temperature(20); +let tempMore = new Temperature(45); +let rangeSec = new util.ScopeHelper(tempLess, tempMore); +let result = range.contains(rangeSec); ``` -### isEmpty(deprecated) -isEmpty(): boolean +### clamp9+ -检查当前缓冲区是否为空。 +clamp(value: ScopeType): ScopeType -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[isEmpty9+](#isempty9)替代。 +将给定值限定到当前范围内。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------------ | ---- | -------------- | +| value | [ScopeType](#scopetype8) | 是 | 传入的给定值。 | + **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| boolean | 如果当前缓冲区不包含任何值，则返回true。 | +| 类型 | 说明 | +| ------------------------ | ------------------------------------------------------------ | +| [ScopeType](#scopetype8) | 如果传入的value小于下限，则返回lowerObj；如果大于上限值则返回upperObj；如果在当前范围内，则返回value。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - let result = pro.isEmpty(); +let tempLower = new Temperature(30); +let tempUpper = new Temperature(40); +let tempMiDF = new Temperature(35); +let range = new util.ScopeHelper(tempLower, tempUpper); +let result = range.clamp(tempMiDF); ``` -### get(deprecated) +## Base64Helper9+ -get(key: K): V | undefined +### constructor9+ -表示要查询的键。 +constructor() -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[get9+](#get9)替代。 +Base64Helper的构造函数。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| key | K | 是 | 要查询的键。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| V \| undefined | 如果指定的键存在于缓冲区中，则返回与键关联的值；否则返回undefined。 | - **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - let result = pro.get(2); +let base64 = new util.Base64Helper(); ``` -### put(deprecated) - -put(key: K,value: V): V +### encodeSync9+ -将键值对添加到缓冲区。 +encodeSync(src: Uint8Array): Uint8Array -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[put9+](#put9)替代。 +通过输入参数编码后输出对应文本。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| key | K | 是 | 要添加的密钥。 | -| value | V | 是 | 指示与要添加的键关联的值。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ---------- | ---- | ------------------- | +| src | Uint8Array | 是 | 编码输入Uint8数组。 | **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| V | 返回与添加的键关联的值；如果要添加的键已经存在，则返回原始值，如果键或值为空，则抛出此异常。 | +| 类型 | 说明 | +| ---------- | ----------------------------- | +| Uint8Array | 返回编码后新分配的Uint8数组。 | **示例：** ```js - let pro = new util.LruBuffer(); - let result = pro.put(2,10); +let that = new util.Base64Helper(); +let array = new Uint8Array([115,49,51]); +let result = that.encodeSync(array); ``` -### values(deprecated) -values(): V[] +### encodeToStringSync9+ -获取当前缓冲区中所有值从最近访问到最近最少访问的顺序列表。 +encodeToStringSync(src: Uint8Array): string -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[values9+](#values9)替代。 +通过输入参数编码后输出对应文本。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ---------- | ---- | ------------------- | +| src | Uint8Array | 是 | 编码输入Uint8数组。 | + **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| V [] | 按从最近访问到最近最少访问的顺序返回当前缓冲区中所有值的列表。 | +| 类型 | 说明 | +| ------ | -------------------- | +| string | 返回编码后的字符串。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - pro.put(2,"anhu"); - pro.put("afaf","grfb"); - let result = pro.values(); +let that = new util.Base64Helper(); +let array = new Uint8Array([115,49,51]); +let result = that.encodeToStringSync(array); ``` -### keys(deprecated) -keys(): K[] +### decodeSync9+ -获取当前缓冲区中所有键从最近访问到最近最少访问的升序列表。 +decodeSync(src: Uint8Array | string): Uint8Array -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[keys9+](#keys9)替代。 +通过输入参数解码后输出对应文本。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------------------ | ---- | ----------------------------- | +| src | Uint8Array \| string | 是 | 解码输入Uint8数组或者字符串。 | + **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| K [] | 按升序返回当前缓冲区中所有键的列表，从最近访问到最近最少访问。 | +| 类型 | 说明 | +| ---------- | ----------------------------- | +| Uint8Array | 返回解码后新分配的Uint8数组。 | **示例：** + ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - let result = pro.keys(); +let that = new util.Base64Helper(); +let buff = 'czEz'; +let result = that.decodeSync(buff); ``` -### remove(deprecated) -remove(key: K): V | undefined +### encode9+ -从当前缓冲区中删除指定的键及其关联的值。 +encode(src: Uint8Array): Promise<Uint8Array> -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[remove9+](#remove9)替代。 +通过输入参数异步编码后输出对应文本。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| key | K | 是 | 要删除的密钥。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ---------- | ---- | ----------------------- | +| src | Uint8Array | 是 | 异步编码输入Uint8数组。 | **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| V \| undefined | 返回一个包含已删除键值对的Optional对象；如果key不存在，则返回一个空的Optional对象，如果key为null，则抛出异常。 | +| 类型 | 说明 | +| ------------------------- | --------------------------------- | +| Promise<Uint8Array> | 返回异步编码后新分配的Uint8数组。 | **示例：** + ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - let result = pro.remove(20); +let that = new util.Base64Helper(); +let array = new Uint8Array([115,49,51]); +let rarray = new Uint8Array([99,122,69,122]); +that.encode(array).then(val=>{ + for (var i = 0; i < rarray.length; i++) { + console.log(val[i].toString()) + } +}) ``` -### afterRemoval(deprecated) -afterRemoval(isEvict: boolean,key: K,value: V,newValue: V): void +### encodeToString9+ -删除值后执行后续操作。 +encodeToString(src: Uint8Array): Promise<string> -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[afterRemoval9+](#afterremoval9)替代。 +通过输入参数异步编码后输出对应文本。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| isEvict | boolean | 是 | 因容量不足而调用该方法时，参数值为true，其他情况为false。 | -| key | K | 是 | 表示删除的键。 | -| value | V | 是 | 表示删除的值。 | -| newValue | V | 是 | 如果已调用put方法并且要添加的键已经存在，则参数值是关联的新值。其他情况下参数值为空。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ---------- | ---- | ----------------------- | +| src | Uint8Array | 是 | 异步编码输入Uint8数组。 | + +**返回值：** + +| 类型 | 说明 | +| --------------------- | ------------------------ | +| Promise<string> | 返回异步编码后的字符串。 | **示例：** ```js - let arr = []; - class ChildLruBuffer extends util.LruBuffer - { - constructor() - { - super(); - } - afterRemoval(isEvict, key, value, newValue) - { - if (isEvict === false) - { - arr = [key, value, newValue]; - } - } - } - let lru = new ChildLruBuffer(); - lru.afterRemoval(false,10,30,null); +let that = new util.Base64Helper(); +let array = new Uint8Array([115,49,51]); +that.encodeToString(array).then(val=>{ + console.log(val) +}) ``` -### contains(deprecated) -contains(key: K): boolean - -检查当前缓冲区是否包含指定的键。 +### decode9+ +decode(src: Uint8Array | string): Promise<Uint8Array> -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[contains9+](#contains9)替代。 +通过输入参数异步解码后输出对应文本。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| key | K | 是 | 表示要检查的键。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------------------ | ---- | --------------------------------- | +| src | Uint8Array \| string | 是 | 异步解码输入Uint8数组或者字符串。 | **返回值：** -| 类型 | 说明 | -| -------- | -------- | -| boolean | 如果缓冲区包含指定的键，则返回 true。 | +| 类型 | 说明 | +| ------------------------- | --------------------------------- | +| Promise<Uint8Array> | 返回异步解码后新分配的Uint8数组。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - let result = pro.contains(20); +let that = new util.Base64Helper(); +let array = new Uint8Array([99,122,69,122]); +let rarray = new Uint8Array([115,49,51]); +that.decode(array).then(val=>{ + for (var i = 0; i < rarray.length; i++) { + console.log(val[i].toString()) + } +}) ``` -### createDefault(deprecated) - -createDefault(key: K): V -如果未计算特定键的值，则执行后续操作，参数表示丢失的键，返回与键关联的值。 - -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[createDefault9+](#createdefault9)替代。 +## types8+ -**系统能力：** SystemCapability.Utils.Lang -**参数：** +### constructor8+ -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| key | K | 是 | 表示丢失的键。 | +constructor() -**返回值：** +Types的构造函数。 -| 类型 | 说明 | -| -------- | -------- | -| V | 返回与键关联的值。 | +**系统能力：** SystemCapability.Utils.Lang **示例：** ```js - let pro = new util.LruBuffer(); - let result = pro.createDefault(50); + let type = new util.types(); ``` -### entries(deprecated) -entries(): IterableIterator<[K,V]> +### isAnyArrayBuffer8+ -允许迭代包含在这个对象中的所有键值对。 +isAnyArrayBuffer(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[entries9+](#entries9)替代。 +检查输入的value是否是ArrayBuffer类型。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | + **返回值：** | 类型 | 说明 | | -------- | -------- | -| [K, V] | 返回一个可迭代数组。 | +| boolean | 判断的结果，如果是ArrayBuffer类型为true，反之为false。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - let result = pro.entries(); + let that = new util.types(); + let result = that.isAnyArrayBuffer(new ArrayBuffer(0)); ``` -### [Symbol.iterator](deprecated) -[Symbol.iterator]\(): IterableIterator<[K, V]> +### isArrayBufferView8+ -返回一个键值对形式的二维数组。 +isArrayBufferView(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[Symbol.iterator9+](#symboliterator9)替代。 +检查输入的value是否是内置ArrayBufferView辅助类型。 + +ArrayBufferView辅助类型包括：Int8Array、Int16Array、Int32Array、Uint8Array、Uint8ClampedArray、Uint32Array、Float32Array、Float64Array、DataView。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | + **返回值：** | 类型 | 说明 | | -------- | -------- | -| [K, V] | 返回一个键值对形式的二维数组。 | +| boolean | 判断的结果，如果是内置包含的ArrayBufferView辅助类型为true，反之为false。 | **示例：** ```js - let pro = new util.LruBuffer(); - pro.put(2,10); - let result = pro[Symbol.iterator](); + let that = new util.types(); + let result = that.isArrayBufferView(new Int8Array([])); ``` -### ScopeType8+ - -用于表示范围中的值的类型。该类型的值，类型可以为ScopeComparable或number。 - -ScopeComparable类型的值需要实现compareTo方法，确保传入的数据具有可比性。 - -```js -interface ScopeComparable{ - compareTo(other: ScopeComparable): boolean; -} -type ScopeType = ScopeComparable | number; -``` - - -构造新类，实现compareTo方法。后续示例代码中，均通过Temperature，获取[ScopeType](#scopetype8)的实例化对象。 - - -示例： -```js -class Temperature{ - constructor(value){ - // 当使用ts语言开发时，需要补充以下代码： - // private readonly _temp: Temperature; - this._temp = value; - } - compareTo(value){ - return this._temp >= value.getTemp(); - } - getTemp(){ - return this._temp; - } - toString(){ - return this._temp.toString(); - } -} -``` - -## ScopeHelper9+ -### constructor9+ +### isArgumentsObject8+ -constructor(lowerObj: ScopeType, upperObj: ScopeType) +isArgumentsObject(value: Object): boolean -用于创建指定下限和上限的作用域实例的构造函数，返回一个ScopeHelper对象。 +检查输入的value是否是一个arguments对象类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------ | ---- | ---------------------- | -| lowerObj | [ScopeType](#scopetype8) | 是 | 指定作用域实例的下限。 | -| upperObj | [ScopeType](#scopetype8) | 是 | 指定作用域实例的上限。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的arguments类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let range = new util.ScopeHelper(tempLower, tempUpper); + let that = new util.types(); + function foo() { + var result = that.isArgumentsObject(arguments); + } + let f = foo(); ``` -### toString9+ +### isArrayBuffer8+ -toString(): string +isArrayBuffer(value: Object): boolean -该字符串化方法返回一个包含当前范围的字符串表示形式。 +检查输入的value是否是ArrayBuffer类型。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | + **返回值：** -| 类型 | 说明 | -| ------ | -------------------------------------- | -| string | 返回包含当前范围对象的字符串表示形式。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的ArrayBuffer类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let range = new util.ScopeHelper(tempLower, tempUpper); -let result = range.toString(); + let that = new util.types(); + let result = that.isArrayBuffer(new ArrayBuffer(0)); ``` -### intersect9+ +### isAsyncFunction8+ -intersect(range: ScopeHelper): ScopeHelper +isAsyncFunction(value: Object): boolean -获取给定范围和当前范围的交集。 +检查输入的value是否是一个异步函数类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---------------------------- | ---- | ------------------ | -| range | [ScopeHelper](#scopehelper9) | 是 | 传入一个给定范围。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ------------------------------ | ------------------------------ | -| [ScopeHelper9+](#scopehelper9) | 返回给定范围和当前范围的交集。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的异步函数类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let range = new util.ScopeHelper(tempLower, tempUpper); -let tempMiDF = new Temperature(35); -let tempMidS = new Temperature(39); -let rangeFir = new util.ScopeHelper(tempMiDF, tempMidS); -range.intersect(rangeFir ); + let that = new util.types(); + let result = that.isAsyncFunction(async function foo() {}); ``` -### intersect9+ +### isBooleanObject8+ -intersect(lowerObj:ScopeType,upperObj:ScopeType):ScopeHelper +isBooleanObject(value: Object): boolean -获取当前范围与给定下限和上限范围的交集。 +检查输入的value是否是一个Boolean对象类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------ | ---- | ---------------- | -| lowerObj | [ScopeType](#scopetype8) | 是 | 给定范围的下限。 | -| upperObj | [ScopeType](#scopetype8) | 是 | 给定范围的上限。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ---------------------------- | ---------------------------------------- | -| [ScopeHelper](#scopehelper9) | 返回当前范围与给定下限和上限范围的交集。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的Boolean对象类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let tempMiDF = new Temperature(35); -let tempMidS = new Temperature(39); -let range = new util.ScopeHelper(tempLower, tempUpper); -let result = range.intersect(tempMiDF, tempMidS); + let that = new util.types(); + let result = that.isBooleanObject(new Boolean(true)); ``` -### getUpper9+ +### isBoxedPrimitive8+ -getUpper(): ScopeType +isBoxedPrimitive(value: Object): boolean -获取当前范围的上限。 +检查输入的value是否是Boolean或Number或String或Symbol对象类型。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | + **返回值：** -| 类型 | 说明 | -| ------------------------ | ---------------------- | -| [ScopeType](#scopetype8) | 返回当前范围的上限值。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的Boolean或Number或String或Symbol对象类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let range = new util.ScopeHelper(tempLower, tempUpper); -let result = range.getUpper(); + let that = new util.types(); + let result = that.isBoxedPrimitive(new Boolean(false)); ``` -### getLower9+ +### isDataView8+ -getLower(): ScopeType +isDataView(value: Object): boolean -获取当前范围的下限。 +检查输入的value是否是DataView类型。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | + **返回值：** -| 类型 | 说明 | -| ------------------------ | ---------------------- | -| [ScopeType](#scopetype8) | 返回当前范围的下限值。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的DataView对象类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let range = new util.ScopeHelper(tempLower, tempUpper); -let result = range.getLower(); + let that = new util.types(); + const ab = new ArrayBuffer(20); + let result = that.isDataView(new DataView(ab)); ``` -### expand9+ +### isDate8+ -expand(lowerObj: ScopeType,upperObj: ScopeType): ScopeHelper +isDate(value: Object): boolean -创建并返回包括当前范围和给定下限和上限的并集。 +检查输入的value是否是Date类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------ | ---- | ---------------- | -| lowerObj | [ScopeType](#scopetype8) | 是 | 给定范围的下限。 | -| upperObj | [ScopeType](#scopetype8) | 是 | 给定范围的上限。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ---------------------------- | ------------------------------------ | -| [ScopeHelper](#scopehelper9) | 返回当前范围和给定下限和上限的并集。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的Date对象类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let tempMiDF = new Temperature(35); -let tempMidS = new Temperature(39); -let range = new util.ScopeHelper(tempLower, tempUpper); -let result = range.expand(tempMiDF, tempMidS); + let that = new util.types(); + let result = that.isDate(new Date()); ``` -### expand9+ +### isExternal8+ -expand(range: ScopeHelper): ScopeHelper +isExternal(value: Object): boolean -创建并返回包括当前范围和给定范围的并集。 +检查输入的value是否是native External类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---------------------------- | ---- | ------------------ | -| range | [ScopeHelper](#scopehelper9) | 是 | 传入一个给定范围。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ---------------------------- | ---------------------------------- | -| [ScopeHelper](#scopehelper9) | 返回包括当前范围和给定范围的并集。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含native External类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let tempMiDF = new Temperature(35); -let tempMidS = new Temperature(39); -let range = new util.ScopeHelper(tempLower, tempUpper); -let rangeFir = new util.ScopeHelper(tempMiDF, tempMidS); -let result = range.expand(rangeFir); + let that = new util.types(); + let result = that.isExternal(true); ``` -### expand9+ +### isFloat32Array8+ -expand(value: ScopeType): ScopeHelper +isFloat32Array(value: Object): boolean -创建并返回包括当前范围和给定值的并集。 +检查输入的value是否是Float32Array数组类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------------------------ | ---- | ---------------- | -| value | [ScopeType](#scopetype8) | 是 | 传入一个给定值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ---------------------------- | -------------------------------- | -| [ScopeHelper](#scopehelper9) | 返回包括当前范围和给定值的并集。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的Float32Array数组类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let tempMiDF = new Temperature(35); -let range = new util.ScopeHelper(tempLower, tempUpper); -let result = range.expand(tempMiDF); + let that = new util.types(); + let result = that.isFloat32Array(new Float32Array()); ``` -### contains9+ +### isFloat64Array8+ -contains(value: ScopeType): boolean +isFloat64Array(value: Object): boolean -检查给定value是否包含在当前范围内。 +检查输入的value是否是Float64Array数组类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------------------------ | ---- | ---------------- | -| value | [ScopeType](#scopetype8) | 是 | 传入一个给定值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ------- | --------------------------------------------------- | -| boolean | 如果给定值包含在当前范围内返回true，否则返回false。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的Float64Array数组类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let tempMiDF = new Temperature(35); -let range = new util.ScopeHelper(tempLower, tempUpper); -range.contains(tempMiDF); + let that = new util.types(); + let result = that.isFloat64Array(new Float64Array()); ``` -### contains9+ +### isGeneratorFunction8+ -contains(range: ScopeHelper): boolean +isGeneratorFunction(value: Object): boolean -检查给定range是否在当前范围内。 +检查输入的value是否是generator函数类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---------------------------- | ---- | ------------------ | -| range | [ScopeHelper](#scopehelper9) | 是 | 传入一个给定范围。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ------- | ----------------------------------------------------- | -| boolean | 如果给定范围包含在当前范围内返回true，否则返回false。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的generator函数类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let range = new util.ScopeHelper(tempLower, tempUpper); -let tempLess = new Temperature(20); -let tempMore = new Temperature(45); -let rangeSec = new util.ScopeHelper(tempLess, tempMore); -let result = range.contains(rangeSec); + let that = new util.types(); + let result = that.isGeneratorFunction(function* foo() {}); ``` -### clamp9+ +### isGeneratorObject8+ -clamp(value: ScopeType): ScopeType +isGeneratorObject(value: Object): boolean -将给定值限定到当前范围内。 +检查输入的value是否是generator对象类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------------------------ | ---- | -------------- | -| value | [ScopeType](#scopetype8) | 是 | 传入的给定值。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ------------------------ | ------------------------------------------------------------ | -| [ScopeType](#scopetype8) | 如果传入的value小于下限，则返回lowerObj；如果大于上限值则返回upperObj；如果在当前范围内，则返回value。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的generator对象类型为true，反之为false。 | **示例：** ```js -let tempLower = new Temperature(30); -let tempUpper = new Temperature(40); -let tempMiDF = new Temperature(35); -let range = new util.ScopeHelper(tempLower, tempUpper); -let result = range.clamp(tempMiDF); + let that = new util.types(); + function* foo() {} + const generator = foo(); + let result = that.isGeneratorObject(generator); ``` -## Scope(deprecated) - -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[ScopeHelper9+](#scopehelper9)替代。 - -### constructor(deprecated) -constructor(lowerObj: ScopeType, upperObj: ScopeType) - -用于创建指定下限和上限的作用域实例的构造函数，返回一个Scope对象。 +### isInt8Array8+ -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[constructor9+](#constructor9)替代。 +isInt8Array(value: Object): boolean +检查输入的value是否是Int8Array数组类型。 **系统能力：** SystemCapability.Utils.Lang @@ -2591,52 +2552,55 @@ constructor(lowerObj: ScopeType, upperObj: ScopeType) | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| lowerObj | [ScopeType](#scopetype8) | 是 | 指定作用域实例的下限。 | -| upperObj | [ScopeType](#scopetype8) | 是 | 指定作用域实例的上限。 | +| value | Object | 是 | 待检测对象。 | + +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的Int8Array数组类型为true，反之为false。 | **示例：** + ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let range = new util.Scope(tempLower, tempUpper); + let that = new util.types(); + let result = that.isInt8Array(new Int8Array([])); ``` -### toString(deprecated) -toString(): string +### isInt16Array8+ -该字符串化方法返回一个包含当前范围的字符串表示形式。 +isInt16Array(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[toString9+](#tostring9)替代。 +检查输入的value是否是Int16Array数组类型。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | + **返回值：** | 类型 | 说明 | | -------- | -------- | -| string | 返回包含当前范围对象的字符串表示形式。 | +| boolean | 判断的结果，如果是内置包含的Int16Array数组类型为true，反之为false。 | **示例：** ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let range = new util.Scope(tempLower, tempUpper); - let result = range.toString(); + let that = new util.types(); + let result = that.isInt16Array(new Int16Array([])); ``` -### intersect(deprecated) -intersect(range: Scope): Scope +### isInt32Array8+ -获取给定范围和当前范围的交集。 +isInt32Array(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[intersect9+](#intersect9)替代。 +检查输入的value是否是Int32Array数组类型。 **系统能力：** SystemCapability.Utils.Lang @@ -2644,35 +2608,27 @@ intersect(range: Scope): Scope | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| range | [Scope](#scopedeprecated) | 是 | 传入一个给定范围。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| [Scope](#scopedeprecated) | 返回给定范围和当前范围的交集。 | +| boolean | 判断的结果，如果是内置包含的Int32Array数组类型为true，反之为false。 | **示例：** ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let range = new util.Scope(tempLower, tempUpper); - let tempMiDF = new Temperature(35); - let tempMidS = new Temperature(39); - let rangeFir = new util.Scope(tempMiDF, tempMidS); - range.intersect(rangeFir ); + let that = new util.types(); + let result = that.isInt32Array(new Int32Array([])); ``` -### intersect(deprecated) -intersect(lowerObj:ScopeType,upperObj:ScopeType):Scope +### isMap8+ -获取当前范围与给定下限和上限范围的交集。 +isMap(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[intersect9+](#intersect9)替代。 +检查输入的value是否是Map类型。 **系统能力：** SystemCapability.Utils.Lang @@ -2680,89 +2636,85 @@ intersect(lowerObj:ScopeType,upperObj:ScopeType):Scope | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| lowerObj | [ScopeType](#scopetype8) | 是 | 给定范围的下限。 | -| upperObj | [ScopeType](#scopetype8) | 是 | 给定范围的上限。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| [Scope](#scopedeprecated) | 返回当前范围与给定下限和上限范围的交集。 | +| boolean | 判断的结果，如果是内置包含的Map类型为true，反之为false。 | **示例：** ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let tempMiDF = new Temperature(35); - let tempMidS = new Temperature(39); - let range = new util.Scope(tempLower, tempUpper); - let result = range.intersect(tempMiDF, tempMidS); + let that = new util.types(); + let result = that.isMap(new Map()); ``` -### getUpper(deprecated) -getUpper(): ScopeType +### isMapIterator8+ -获取当前范围的上限。 +isMapIterator(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[getUpper9+](#getupper9)替代。 +检查输入的value是否是Map的Iterator类型。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | + **返回值：** | 类型 | 说明 | | -------- | -------- | -| [ScopeType](#scopetype8) | 返回当前范围的上限值。 | +| boolean | 判断的结果，如果是内置包含的Map的Iterator类型为true，反之为false。 | **示例：** ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let range = new util.Scope(tempLower, tempUpper); - let result = range.getUpper(); + let that = new util.types(); + const map = new Map(); + let result = that.isMapIterator(map.keys()); ``` -### getLower(deprecated) -getLower(): ScopeType +### isNativeError8+ -获取当前范围的下限。 +isNativeError(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[getLower9+](#getlower9)替代。 +检查输入的value是否是Error类型。 **系统能力：** SystemCapability.Utils.Lang +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | + **返回值：** | 类型 | 说明 | | -------- | -------- | -| [ScopeType](#scopetype8) | 返回当前范围的下限值。 | +| boolean | 判断的结果，如果是内置包含的Error类型为true，反之为false。 | **示例：** ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let range = new util.Scope(tempLower, tempUpper); - let result = range.getLower(); + let that = new util.types(); + let result = that.isNativeError(new TypeError()); ``` -### expand(deprecated) -expand(lowerObj: ScopeType,upperObj: ScopeType): Scope +### isNumberObject8+ -创建并返回包括当前范围和给定下限和上限的并集。 +isNumberObject(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[expand9+](#expand9)替代。 +检查输入的value是否是Number对象类型。 **系统能力：** SystemCapability.Utils.Lang @@ -2770,35 +2722,27 @@ expand(lowerObj: ScopeType,upperObj: ScopeType): Scope | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| lowerObj | [ScopeType](#scopetype8) | 是 | 给定范围的下限。 | -| upperObj | [ScopeType](#scopetype8) | 是 | 给定范围的上限。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| [Scope](#scopedeprecated) | 返回当前范围和给定下限和上限的并集。 | +| boolean | 判断的结果，如果是内置包含的Number对象类型为true，反之为false。 | **示例：** ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let tempMiDF = new Temperature(35); - let tempMidS = new Temperature(39); - let range = new util.Scope(tempLower, tempUpper); - let result = range.expand(tempMiDF, tempMidS); + let that = new util.types(); + let result = that.isNumberObject(new Number(0)); ``` -### expand(deprecated) -expand(range: Scope): Scope +### isPromise8+ -创建并返回包括当前范围和给定范围的并集。 +isPromise(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[expand9+](#expand9)替代。 +检查输入的value是否是Promise类型。 **系统能力：** SystemCapability.Utils.Lang @@ -2806,35 +2750,27 @@ expand(range: Scope): Scope | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| range | [Scope](#scopedeprecated) | 是 | 传入一个给定范围。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| [Scope](#scopedeprecated) | 返回包括当前范围和给定范围的并集。 | +| boolean | 判断的结果，如果是内置包含的Promise类型为true，反之为false。 | **示例：** ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let tempMiDF = new Temperature(35); - let tempMidS = new Temperature(39); - let range = new util.Scope(tempLower, tempUpper); - let rangeFir = new util.Scope(tempMiDF, tempMidS); - let result = range.expand(rangeFir); + let that = new util.types(); + let result = that.isPromise(Promise.resolve(1)); ``` -### expand(deprecated) -expand(value: ScopeType): Scope +### isProxy8+ -创建并返回包括当前范围和给定值的并集。 +isProxy(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[expand9+](#expand9)替代。 +检查输入的value是否是Proxy类型。 **系统能力：** SystemCapability.Utils.Lang @@ -2842,33 +2778,29 @@ expand(value: ScopeType): Scope | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | [ScopeType](#scopetype8) | 是 | 传入一个给定值。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| [Scope](#scopedeprecated) | 返回包括当前范围和给定值的并集。 | +| boolean | 判断的结果，如果是内置包含的Proxy类型为true，反之为false。 | **示例：** ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let tempMiDF = new Temperature(35); - let range = new util.Scope(tempLower, tempUpper); - let result = range.expand(tempMiDF); + let that = new util.types(); + const target = {}; + const proxy = new Proxy(target, {}); + let result = that.isProxy(proxy); ``` -### contains(deprecated) -contains(value: ScopeType): boolean +### isRegExp8+ -检查给定value是否包含在当前范围内。 +isRegExp(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[contains9+](#contains9)替代。 +检查输入的value是否是RegExp类型。 **系统能力：** SystemCapability.Utils.Lang @@ -2876,33 +2808,27 @@ contains(value: ScopeType): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | [ScopeType](#scopetype8) | 是 | 传入一个给定值。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 如果给定值包含在当前范围内返回true，否则返回false。 | +| boolean | 判断的结果，如果是内置包含的RegExp类型为true，反之为false。 | **示例：** ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let tempMiDF = new Temperature(35); - let range = new util.Scope(tempLower, tempUpper); - range.contains(tempMiDF); + let that = new util.types(); + let result = that.isRegExp(new RegExp('abc')); ``` -### contains(deprecated) -contains(range: Scope): boolean +### isSet8+ -检查给定range是否在当前范围内。 +isSet(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[contains9+](#contains9)替代。 +检查输入的value是否是Set类型。 **系统能力：** SystemCapability.Utils.Lang @@ -2910,36 +2836,27 @@ contains(range: Scope): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| range | [Scope](#scopedeprecated) | 是 | 传入一个给定范围。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 如果给定范围包含在当前范围内返回true，否则返回false。 | +| boolean | 判断的结果，如果是内置包含的Set类型为true，反之为false。 | **示例：** ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let range = new util.Scope(tempLower, tempUpper); - let tempLess = new Temperature(20); - let tempMore = new Temperature(45); - let rangeSec = new util.Scope(tempLess, tempMore); - let result = range.contains(rangeSec); + let that = new util.types(); + let result = that.isSet(new Set()); ``` -### clamp(deprecated) - -clamp(value: ScopeType): ScopeType +### isSetIterator8+ -将给定值限定到当前范围内。 +isSetIterator(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[clamp9+](#clamp9)替代。 +检查输入的value是否是Set的Iterator类型。 **系统能力：** SystemCapability.Utils.Lang @@ -2947,259 +2864,227 @@ clamp(value: ScopeType): ScopeType | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | [ScopeType](#scopetype8) | 是 | 传入的给定值。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| [ScopeType](#scopetype8) | 如果传入的value小于下限，则返回lowerObj；如果大于上限值则返回upperObj；如果在当前范围内，则返回value。 | +| boolean | 判断的结果，如果是内置包含的Set的Iterator类型为true，反之为false。 | **示例：** ```js - let tempLower = new Temperature(30); - let tempUpper = new Temperature(40); - let tempMiDF = new Temperature(35); - let range = new util.Scope(tempLower, tempUpper); - let result = range.clamp(tempMiDF); + let that = new util.types(); + const set = new Set(); + let result = that.isSetIterator(set.keys()); ``` -## Base64Helper9+ - -### constructor9+ - -constructor() - -Base64Helper的构造函数。 - -**系统能力：** SystemCapability.Utils.Lang - -**示例：** - - ```js -let base64 = new util.Base64Helper(); - ``` -### encodeSync9+ +### isStringObject8+ -encodeSync(src: Uint8Array): Uint8Array +isStringObject(value: Object): boolean -通过输入参数编码后输出对应文本。 +检查输入的value是否是String对象类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---------- | ---- | ------------------- | -| src | Uint8Array | 是 | 编码输入Uint8数组。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ---------- | ----------------------------- | -| Uint8Array | 返回编码后新分配的Uint8数组。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的String对象类型为true，反之为false。 | **示例：** ```js -let that = new util.Base64Helper(); -let array = new Uint8Array([115,49,51]); -let result = that.encodeSync(array); + let that = new util.types(); + let result = that.isStringObject(new String('foo')); ``` -### encodeToStringSync9+ +### isSymbolObjec8+ -encodeToStringSync(src: Uint8Array): string +isSymbolObject(value: Object): boolean -通过输入参数编码后输出对应文本。 +检查输入的value是否是Symbol对象类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---------- | ---- | ------------------- | -| src | Uint8Array | 是 | 编码输入Uint8数组。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ------ | -------------------- | -| string | 返回编码后的字符串。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的Symbol对象类型为true，反之为false。 | **示例：** ```js -let that = new util.Base64Helper(); -let array = new Uint8Array([115,49,51]); -let result = that.encodeToStringSync(array); + let that = new util.types(); + const symbols = Symbol('foo'); + let result = that.isSymbolObject(Object(symbols)); ``` -### decodeSync9+ +### isTypedArray8+ -decodeSync(src: Uint8Array | string): Uint8Array +isTypedArray(value: Object): boolean -通过输入参数解码后输出对应文本。 +检查输入的value是否是TypedArray类型的辅助类型。 + +TypedArray类型的辅助类型，包括Int8Array、Int16Array、Int32Array、Uint8Array、Uint8ClampedArray、Uint16Array、Uint32Array、Float32Array、Float64Array、DataView。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------------------------------ | ---- | ----------------------------- | -| src | Uint8Array \| string | 是 | 解码输入Uint8数组或者字符串。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ---------- | ----------------------------- | -| Uint8Array | 返回解码后新分配的Uint8数组。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的TypedArray包含的类型为true，反之为false。 | **示例：** ```js -let that = new util.Base64Helper(); -let buff = 'czEz'; -let result = that.decodeSync(buff); + let that = new util.types(); + let result = that.isTypedArray(new Float64Array([])); ``` -### encode9+ +### isUint8Array8+ -encode(src: Uint8Array): Promise<Uint8Array> +isUint8Array(value: Object): boolean -通过输入参数异步编码后输出对应文本。 +检查输入的value是否是Uint8Array数组类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---------- | ---- | ----------------------- | -| src | Uint8Array | 是 | 异步编码输入Uint8数组。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ------------------------- | --------------------------------- | -| Promise<Uint8Array> | 返回异步编码后新分配的Uint8数组。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的Uint8Array数组类型为true，反之为false。 | **示例：** ```js -let that = new util.Base64Helper(); -let array = new Uint8Array([115,49,51]); -let rarray = new Uint8Array([99,122,69,122]); -that.encode(array).then(val=>{ - for (var i = 0; i < rarray.length; i++) { - console.log(val[i].toString()) - } -}) + let that = new util.types(); + let result = that.isUint8Array(new Uint8Array([])); ``` -### encodeToString9+ +### isUint8ClampedArray8+ -encodeToString(src: Uint8Array): Promise<string> +isUint8ClampedArray(value: Object): boolean -通过输入参数异步编码后输出对应文本。 +检查输入的value是否是Uint8ClampedArray数组类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ---------- | ---- | ----------------------- | -| src | Uint8Array | 是 | 异步编码输入Uint8数组。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| --------------------- | ------------------------ | -| Promise<string> | 返回异步编码后的字符串。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的Uint8ClampedArray数组类型为true，反之为false。 | **示例：** ```js -let that = new util.Base64Helper(); -let array = new Uint8Array([115,49,51]); -that.encodeToString(array).then(val=>{ - console.log(val) -}) + let that = new util.types(); + let result = that.isUint8ClampedArray(new Uint8ClampedArray([])); ``` -### decode9+ +### isUint16Array8+ -decode(src: Uint8Array | string): Promise<Uint8Array> +isUint16Array(value: Object): boolean -通过输入参数异步解码后输出对应文本。 +检查输入的value是否是Uint16Array数组类型。 **系统能力：** SystemCapability.Utils.Lang **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------------------------------ | ---- | --------------------------------- | -| src | Uint8Array \| string | 是 | 异步解码输入Uint8数组或者字符串。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | **返回值：** -| 类型 | 说明 | -| ------------------------- | --------------------------------- | -| Promise<Uint8Array> | 返回异步解码后新分配的Uint8数组。 | +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的Uint16Array数组类型为true，反之为false。 | **示例：** ```js -let that = new util.Base64Helper(); -let array = new Uint8Array([99,122,69,122]); -let rarray = new Uint8Array([115,49,51]); -that.decode(array).then(val=>{ - for (var i = 0; i < rarray.length; i++) { - console.log(val[i].toString()) - } -}) + let that = new util.types(); + let result = that.isUint16Array(new Uint16Array([])); ``` -## Base64(deprecated) +### isUint32Array8+ -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[Base64Helper9+](#base64helper9)替代。 +isUint32Array(value: Object): boolean -### constructor(deprecated) +检查输入的value是否是Uint32Array数组类型。 -constructor() +**系统能力：** SystemCapability.Utils.Lang -Base64的构造函数。 +**参数：** -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[constructor9+](#constructor9)替代。 +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| value | Object | 是 | 待检测对象。 | -**系统能力：** SystemCapability.Utils.Lang +**返回值：** + +| 类型 | 说明 | +| -------- | -------- | +| boolean | 判断的结果，如果是内置包含的Uint32Array数组类型为true，反之为false。 | **示例：** ```js - let base64 = new util.Base64(); + let that = new util.types(); + let result = that.isUint32Array(new Uint32Array([])); ``` -### encodeSync(deprecated) -encodeSync(src: Uint8Array): Uint8Array +### isWeakMap8+ -通过输入参数编码后输出对应文本。 +isWeakMap(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[encodeSync9+](#encodesync9)替代。 +检查输入的value是否是WeakMap类型。 **系统能力：** SystemCapability.Utils.Lang @@ -3207,31 +3092,27 @@ encodeSync(src: Uint8Array): Uint8Array | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| src | Uint8Array | 是 | 编码输入Uint8数组。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| Uint8Array | 返回编码后新分配的Uint8数组。 | +| boolean | 判断的结果，如果是内置包含的WeakMap类型为true，反之为false。 | **示例：** ```js - let that = new util.Base64(); - let array = new Uint8Array([115,49,51]); - let result = that.encodeSync(array); + let that = new util.types(); + let result = that.isWeakMap(new WeakMap()); ``` -### encodeToStringSync(deprecated) -encodeToStringSync(src: Uint8Array): string +### isWeakSet8+ -通过输入参数编码后输出对应文本。 +isWeakSet(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[encodeToStringSync9+](#encodetostringsync9)替代。 +检查输入的value是否是WeakSet类型。 **系统能力：** SystemCapability.Utils.Lang @@ -3239,31 +3120,27 @@ encodeToStringSync(src: Uint8Array): string | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| src | Uint8Array | 是 | 编码输入Uint8数组。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| string | 返回编码后的字符串。 | +| boolean | 判断的结果，如果是内置包含的WeakSet类型为true，反之为false。 | **示例：** ```js - let that = new util.Base64(); - let array = new Uint8Array([115,49,51]); - let result = that.encodeToStringSync(array); + let that = new util.types(); + let result = that.isWeakSet(new WeakSet()); ``` -### decodeSync(deprecated) -decodeSync(src: Uint8Array | string): Uint8Array +### isBigInt64Array8+ -通过输入参数解码后输出对应文本。 +isBigInt64Array(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[decodeSync9+](#decodesync9)替代。 +检查输入的value是否是BigInt64Array类型。 **系统能力：** SystemCapability.Utils.Lang @@ -3271,31 +3148,27 @@ decodeSync(src: Uint8Array | string): Uint8Array | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| src | Uint8Array \| string | 是 | 解码输入Uint8数组或者字符串。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| Uint8Array | 返回解码后新分配的Uint8数组。 | +| boolean | 判断的结果，如果是内置包含的BigInt64Array类型为true，反之为false。 | **示例：** ```js - let that = new util.Base64(); - let buff = 'czEz'; - let result = that.decodeSync(buff); + let that = new util.types(); + let result = that.isBigInt64Array(new BigInt64Array([])); ``` -### encode(deprecated) -encode(src: Uint8Array): Promise<Uint8Array> +### isBigUint64Array8+ -通过输入参数异步编码后输出对应文本。 +isBigUint64Array(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[encode9+](#encode9)替代。 +检查输入的value是否是BigUint64Array类型。 **系统能力：** SystemCapability.Utils.Lang @@ -3303,36 +3176,27 @@ encode(src: Uint8Array): Promise<Uint8Array> | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| src | Uint8Array | 是 | 异步编码输入Uint8数组。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| Promise<Uint8Array> | 返回异步编码后新分配的Uint8数组。 | +| boolean | 判断的结果，如果是内置包含的BigUint64Array类型为true，反之为false。 | **示例：** ```js - let that = new util.Base64(); - let array = new Uint8Array([115,49,51]); - let rarray = new Uint8Array([99,122,69,122]); - that.encode(array).then(val=>{ - for (var i = 0; i < rarray.length; i++) { - console.log(val[i].toString()) - } - }) + let that = new util.types(); + let result = that.isBigUint64Array(new BigUint64Array([])); ``` -### encodeToString(deprecated) -encodeToString(src: Uint8Array): Promise<string> +### isModuleNamespaceObject8+ -通过输入参数异步编码后输出对应文本。 +isModuleNamespaceObject(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[encodeToString9+](#encodetostring9)替代。 +检查输入的value是否是Module Namespace Object类型。 **系统能力：** SystemCapability.Utils.Lang @@ -3340,34 +3204,28 @@ encodeToString(src: Uint8Array): Promise<string> | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| src | Uint8Array | 是 | 异步编码输入Uint8数组。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| Promise<string> | 返回异步编码后的字符串。 | +| boolean | 判断的结果，如果是内置包含的Module Namespace Object类型为true，反之为false。 | **示例：** ```js - let that = new util.Base64(); - let array = new Uint8Array([115,49,51]); - that.encodeToString(array).then(val=>{ - console.log(val) - }) + import url from '@ohos.url' + let that = new util.types(); + let result = that.isModuleNamespaceObject(url); ``` -### decode(deprecated) - -decode(src: Uint8Array | string): Promise<Uint8Array> +### isSharedArrayBuffer8+ -通过输入参数异步解码后输出对应文本。 +isSharedArrayBuffer(value: Object): boolean -> **说明：** -> -> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[decode9+](#decode9)替代。 +检查输入的value是否是SharedArrayBuffer类型。 **系统能力：** SystemCapability.Utils.Lang @@ -3375,50 +3233,53 @@ decode(src: Uint8Array | string): Promise<Uint8Array> | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| src | Uint8Array \| string | 是 | 异步解码输入Uint8数组或者字符串。 | +| value | Object | 是 | 待检测对象。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| Promise<Uint8Array> | 返回异步解码后新分配的Uint8数组。 | +| boolean | 判断的结果，如果是内置包含的SharedArrayBuffer类型为true，反之为false。 | **示例：** ```js - let that = new util.Base64(); - let array = new Uint8Array([99,122,69,122]); - let rarray = new Uint8Array([115,49,51]); - that.decode(array).then(val=>{ - for (var i = 0; i < rarray.length; i++) { - console.log(val[i].toString()) - } - }) + let that = new util.types(); + let result = that.isSharedArrayBuffer(new SharedArrayBuffer(0)); ``` -## types8+ - +## LruBuffer(deprecated) -### constructor8+ +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[LRUCache9+](#lrucache9)替代。 -constructor() +### 属性 -Types的构造函数。 +**系统能力：** 以下各项对应的系统能力均为SystemCapability.Utils.Lang。 -**系统能力：** SystemCapability.Utils.Lang +| 名称 | 类型 | 可读 | 可写 | 说明 | +| -------- | -------- | -------- | -------- | -------- | +| length | number | 是 | 否 | 当前缓冲区中值的总数。 | **示例：** ```js - let type = new util.types(); + let pro = new util.LruBuffer(); + pro.put(2,10); + pro.put(1,8); + let result = pro.length; ``` +### constructor(deprecated) -### isAnyArrayBuffer8+ +constructor(capacity?: number) -isAnyArrayBuffer(value: Object): boolean +默认构造函数用于创建一个新的LruBuffer实例，默认容量为64。 -检查输入的value是否是ArrayBuffer类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[constructor9+](#constructor9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -3426,29 +3287,23 @@ isAnyArrayBuffer(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| boolean | 判断的结果，如果是ArrayBuffer类型为true，反之为false。 | +| capacity | number | 否 | 指示要为缓冲区自定义的容量。 | **示例：** ```js - let that = new util.types(); - let result = that.isAnyArrayBuffer(new ArrayBuffer(0)); + let lrubuffer= new util.LruBuffer(); ``` +### updateCapacity(deprecated) -### isArrayBufferView8+ - -isArrayBufferView(value: Object): boolean +updateCapacity(newCapacity: number): void -检查输入的value是否是内置ArrayBufferView辅助类型。 +将缓冲区容量更新为指定容量，如果newCapacity小于或等于0，则抛出异常。 -ArrayBufferView辅助类型包括：Int8Array、Int16Array、Int32Array、Uint8Array、Uint8ClampedArray、Uint32Array、Float32Array、Float64Array、DataView。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[updateCapacity9+](#updatecapacity9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -3456,255 +3311,257 @@ ArrayBufferView辅助类型包括：Int8Array、Int16Array、Int32Array、Uint8A | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| boolean | 判断的结果，如果是内置包含的ArrayBufferView辅助类型为true，反之为false。 | +| newCapacity | number | 是 | 指示要为缓冲区自定义的容量。 | **示例：** ```js - let that = new util.types(); - let result = that.isArrayBufferView(new Int8Array([])); + let pro = new util.LruBuffer(); + let result = pro.updateCapacity(100); ``` +### toString(deprecated) -### isArgumentsObject8+ +toString(): string -isArgumentsObject(value: Object): boolean +返回对象的字符串表示形式。 -检查输入的value是否是一个arguments对象类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[toString9+](#tostring9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的arguments类型为true，反之为false。 | +| string | 返回对象的字符串表示形式。 | **示例：** ```js - let that = new util.types(); - function foo() { - var result = that.isArgumentsObject(arguments); - } - let f = foo(); + let pro = new util.LruBuffer(); + pro.put(2,10); + pro.get(2); + pro.remove(20); + let result = pro.toString(); ``` +### getCapacity(deprecated) -### isArrayBuffer8+ +getCapacity(): number -isArrayBuffer(value: Object): boolean +获取当前缓冲区的容量。 -检查输入的value是否是ArrayBuffer类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[getCapacity9+](#getcapacity9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的ArrayBuffer类型为true，反之为false。 | +| number | 返回当前缓冲区的容量。 | **示例：** - ```js - let that = new util.types(); - let result = that.isArrayBuffer(new ArrayBuffer(0)); + let pro = new util.LruBuffer(); + let result = pro.getCapacity(); ``` +### clear(deprecated) -### isAsyncFunction8+ +clear(): void -isAsyncFunction(value: Object): boolean +从当前缓冲区清除键值对。后续会调用afterRemoval()方法执行后续操作。 -检查输入的value是否是一个异步函数类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[clear9+](#clear9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** +**示例：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | + ```js + let pro = new util.LruBuffer(); + pro.put(2,10); + let result = pro.length; + pro.clear(); + ``` + +### getCreateCount(deprecated) + +getCreateCount(): number + +获取createDefault()返回值的次数。 + +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[getCreateCount9+](#getcreatecount9)替代。 + +**系统能力：** SystemCapability.Utils.Lang **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的异步函数类型为true，反之为false。 | +| number | 返回createDefault()返回值的次数。 | **示例：** ```js - let that = new util.types(); - let result = that.isAsyncFunction(async function foo() {}); + let pro = new util.LruBuffer(); + pro.put(1,8); + let result = pro.getCreateCount(); ``` +### getMissCount(deprecated) -### isBooleanObject8+ +getMissCount(): number -isBooleanObject(value: Object): boolean +获取查询值不匹配的次数。 -检查输入的value是否是一个Boolean对象类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[getMissCount9+](#getmisscount9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Boolean对象类型为true，反之为false。 | +| number | 返回查询值不匹配的次数。 | **示例：** ```js - let that = new util.types(); - let result = that.isBooleanObject(new Boolean(true)); + let pro = new util.LruBuffer(); + pro.put(2,10); + pro.get(2); + let result = pro.getMissCount(); ``` +### getRemovalCount(deprecated) -### isBoxedPrimitive8+ +getRemovalCount(): number -isBoxedPrimitive(value: Object): boolean +获取从缓冲区中逐出值的次数。 -检查输入的value是否是Boolean或Number或String或Symbol对象类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[getRemovalCount9+](#getremovalcount9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Boolean或Number或String或Symbol对象类型为true，反之为false。 | +| number | 返回从缓冲区中驱逐的次数。 | **示例：** ```js - let that = new util.types(); - let result = that.isBoxedPrimitive(new Boolean(false)); + let pro = new util.LruBuffer(); + pro.put(2,10); + pro.updateCapacity(2); + pro.put(50,22); + let result = pro.getRemovalCount(); ``` +### getMatchCount(deprecated) -### isDataView8+ +getMatchCount(): number -isDataView(value: Object): boolean +获取查询值匹配成功的次数。 -检查输入的value是否是DataView类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[getMatchCount9+](#getmatchcount9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的DataView对象类型为true，反之为false。 | +| number | 返回查询值匹配成功的次数。 | **示例：** ```js - let that = new util.types(); - const ab = new ArrayBuffer(20); - let result = that.isDataView(new DataView(ab)); + let pro = new util.LruBuffer(); + pro.put(2,10); + pro.get(2); + let result = pro.getMatchCount(); ``` +### getPutCount(deprecated) -### isDate8+ +getPutCount(): number -isDate(value: Object): boolean +获取将值添加到缓冲区的次数。 -检查输入的value是否是Date类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[getPutCount9+](#getputcount9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Date对象类型为true，反之为false。 | +| number | 返回将值添加到缓冲区的次数。 | **示例：** ```js - let that = new util.types(); - let result = that.isDate(new Date()); + let pro = new util.LruBuffer(); + pro.put(2,10); + let result = pro.getPutCount(); ``` +### isEmpty(deprecated) -### isExternal8+ +isEmpty(): boolean -isExternal(value: Object): boolean +检查当前缓冲区是否为空。 -检查输入的value是否是native External类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[isEmpty9+](#isempty9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含native External类型为true，反之为false。 | +| boolean | 如果当前缓冲区不包含任何值，则返回true。 | **示例：** ```js - let that = new util.types(); - let result = that.isExternal(true); + let pro = new util.LruBuffer(); + pro.put(2,10); + let result = pro.isEmpty(); ``` +### get(deprecated) -### isFloat32Array8+ +get(key: K): V | undefined -isFloat32Array(value: Object): boolean +表示要查询的键。 -检查输入的value是否是Float32Array数组类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[get9+](#get9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -3712,27 +3569,31 @@ isFloat32Array(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| key | K | 是 | 要查询的键。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Float32Array数组类型为true，反之为false。 | +| V \| undefined | 如果指定的键存在于缓冲区中，则返回与键关联的值；否则返回undefined。 | **示例：** ```js - let that = new util.types(); - let result = that.isFloat32Array(new Float32Array()); + let pro = new util.LruBuffer(); + pro.put(2,10); + let result = pro.get(2); ``` +### put(deprecated) -### isFloat64Array8+ +put(key: K,value: V): V -isFloat64Array(value: Object): boolean +将键值对添加到缓冲区。 -检查输入的value是否是Float64Array数组类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[put9+](#put9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -3740,85 +3601,84 @@ isFloat64Array(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| key | K | 是 | 要添加的密钥。 | +| value | V | 是 | 指示与要添加的键关联的值。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Float64Array数组类型为true，反之为false。 | +| V | 返回与添加的键关联的值；如果要添加的键已经存在，则返回原始值，如果键或值为空，则抛出此异常。 | **示例：** ```js - let that = new util.types(); - let result = that.isFloat64Array(new Float64Array()); + let pro = new util.LruBuffer(); + let result = pro.put(2,10); ``` +### values(deprecated) -### isGeneratorFunction8+ +values(): V[] -isGeneratorFunction(value: Object): boolean +获取当前缓冲区中所有值从最近访问到最近最少访问的顺序列表。 -检查输入的value是否是generator函数类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[values9+](#values9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的generator函数类型为true，反之为false。 | +| V [] | 按从最近访问到最近最少访问的顺序返回当前缓冲区中所有值的列表。 | **示例：** ```js - let that = new util.types(); - let result = that.isGeneratorFunction(function* foo() {}); + let pro = new util.LruBuffer(); + pro.put(2,10); + pro.put(2,"anhu"); + pro.put("afaf","grfb"); + let result = pro.values(); ``` +### keys(deprecated) -### isGeneratorObject8+ +keys(): K[] -isGeneratorObject(value: Object): boolean +获取当前缓冲区中所有键从最近访问到最近最少访问的升序列表。 -检查输入的value是否是generator对象类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[keys9+](#keys9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的generator对象类型为true，反之为false。 | +| K [] | 按升序返回当前缓冲区中所有键的列表，从最近访问到最近最少访问。 | **示例：** - ```js - let that = new util.types(); - function* foo() {} - const generator = foo(); - let result = that.isGeneratorObject(generator); + let pro = new util.LruBuffer(); + pro.put(2,10); + let result = pro.keys(); ``` +### remove(deprecated) -### isInt8Array8+ +remove(key: K): V | undefined -isInt8Array(value: Object): boolean +从当前缓冲区中删除指定的键及其关联的值。 -检查输入的value是否是Int8Array数组类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[remove9+](#remove9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -3826,27 +3686,30 @@ isInt8Array(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| key | K | 是 | 要删除的密钥。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Int8Array数组类型为true，反之为false。 | +| V \| undefined | 返回一个包含已删除键值对的Optional对象；如果key不存在，则返回一个空的Optional对象，如果key为null，则抛出异常。 | **示例：** - ```js - let that = new util.types(); - let result = that.isInt8Array(new Int8Array([])); + let pro = new util.LruBuffer(); + pro.put(2,10); + let result = pro.remove(20); ``` +### afterRemoval(deprecated) -### isInt16Array8+ +afterRemoval(isEvict: boolean,key: K,value: V,newValue: V): void -isInt16Array(value: Object): boolean +删除值后执行后续操作。 -检查输入的value是否是Int16Array数组类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[afterRemoval9+](#afterremoval9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -3854,27 +3717,43 @@ isInt16Array(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - -**返回值：** - -| 类型 | 说明 | -| -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Int16Array数组类型为true，反之为false。 | +| isEvict | boolean | 是 | 因容量不足而调用该方法时，参数值为true，其他情况为false。 | +| key | K | 是 | 表示删除的键。 | +| value | V | 是 | 表示删除的值。 | +| newValue | V | 是 | 如果已调用put方法并且要添加的键已经存在，则参数值是关联的新值。其他情况下参数值为空。 | **示例：** ```js - let that = new util.types(); - let result = that.isInt16Array(new Int16Array([])); + let arr = []; + class ChildLruBuffer extends util.LruBuffer + { + constructor() + { + super(); + } + afterRemoval(isEvict, key, value, newValue) + { + if (isEvict === false) + { + arr = [key, value, newValue]; + } + } + } + let lru = new ChildLruBuffer(); + lru.afterRemoval(false,10,30,null); ``` +### contains(deprecated) -### isInt32Array8+ +contains(key: K): boolean -isInt32Array(value: Object): boolean +检查当前缓冲区是否包含指定的键。 -检查输入的value是否是Int32Array数组类型。 + +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[contains9+](#contains9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -3882,27 +3761,31 @@ isInt32Array(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| key | K | 是 | 表示要检查的键。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Int32Array数组类型为true，反之为false。 | +| boolean | 如果缓冲区包含指定的键，则返回 true。 | **示例：** ```js - let that = new util.types(); - let result = that.isInt32Array(new Int32Array([])); + let pro = new util.LruBuffer(); + pro.put(2,10); + let result = pro.contains(20); ``` +### createDefault(deprecated) -### isMap8+ +createDefault(key: K): V -isMap(value: Object): boolean +如果未计算特定键的值，则执行后续操作，参数表示丢失的键，返回与键关联的值。 -检查输入的value是否是Map类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[createDefault9+](#createdefault9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -3910,113 +3793,126 @@ isMap(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| key | K | 是 | 表示丢失的键。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Map类型为true，反之为false。 | +| V | 返回与键关联的值。 | **示例：** ```js - let that = new util.types(); - let result = that.isMap(new Map()); + let pro = new util.LruBuffer(); + let result = pro.createDefault(50); ``` +### entries(deprecated) -### isMapIterator8+ +entries(): IterableIterator<[K,V]> -isMapIterator(value: Object): boolean +允许迭代包含在这个对象中的所有键值对。 -检查输入的value是否是Map的Iterator类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[entries9+](#entries9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Map的Iterator类型为true，反之为false。 | +| [K, V] | 返回一个可迭代数组。 | **示例：** ```js - let that = new util.types(); - const map = new Map(); - let result = that.isMapIterator(map.keys()); + let pro = new util.LruBuffer(); + pro.put(2,10); + let result = pro.entries(); ``` +### [Symbol.iterator](deprecated) -### isNativeError8+ +[Symbol.iterator]\(): IterableIterator<[K, V]> -isNativeError(value: Object): boolean +返回一个键值对形式的二维数组。 -检查输入的value是否是Error类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[Symbol.iterator9+](#symboliterator9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Error类型为true，反之为false。 | +| [K, V] | 返回一个键值对形式的二维数组。 | **示例：** ```js - let that = new util.types(); - let result = that.isNativeError(new TypeError()); + let pro = new util.LruBuffer(); + pro.put(2,10); + let result = pro[Symbol.iterator](); ``` +### ScopeType8+ -### isNumberObject8+ +用于表示范围中的值的类型。该类型的值，类型可以为ScopeComparable或number。 -isNumberObject(value: Object): boolean +ScopeComparable类型的值需要实现compareTo方法，确保传入的数据具有可比性。 -检查输入的value是否是Number对象类型。 +```js +interface ScopeComparable{ + compareTo(other: ScopeComparable): boolean; +} +type ScopeType = ScopeComparable | number; +``` -**系统能力：** SystemCapability.Utils.Lang -**参数：** +构造新类，实现compareTo方法。后续示例代码中，均通过Temperature，获取[ScopeType](#scopetype8)的实例化对象。 -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | -**返回值：** +示例： +```js +class Temperature{ + constructor(value){ + // 当使用ts语言开发时，需要补充以下代码： + // private readonly _temp: Temperature; + this._temp = value; + } + compareTo(value){ + return this._temp >= value.getTemp(); + } + getTemp(){ + return this._temp; + } + toString(){ + return this._temp.toString(); + } +} +``` -| 类型 | 说明 | -| -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Number对象类型为true，反之为false。 | +## Scope(deprecated) -**示例：** +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[ScopeHelper9+](#scopehelper9)替代。 - ```js - let that = new util.types(); - let result = that.isNumberObject(new Number(0)); - ``` +### constructor(deprecated) +constructor(lowerObj: ScopeType, upperObj: ScopeType) -### isPromise8+ +用于创建指定下限和上限的作用域实例的构造函数，返回一个Scope对象。 -isPromise(value: Object): boolean +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[constructor9+](#constructor9)替代。 -检查输入的value是否是Promise类型。 **系统能力：** SystemCapability.Utils.Lang @@ -4024,27 +3920,52 @@ isPromise(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| lowerObj | [ScopeType](#scopetype8) | 是 | 指定作用域实例的下限。 | +| upperObj | [ScopeType](#scopetype8) | 是 | 指定作用域实例的上限。 | + +**示例：** + ```js + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let range = new util.Scope(tempLower, tempUpper); + ``` + +### toString(deprecated) + +toString(): string + +该字符串化方法返回一个包含当前范围的字符串表示形式。 + +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[toString9+](#tostring9)替代。 + +**系统能力：** SystemCapability.Utils.Lang **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Promise类型为true，反之为false。 | +| string | 返回包含当前范围对象的字符串表示形式。 | **示例：** ```js - let that = new util.types(); - let result = that.isPromise(Promise.resolve(1)); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let range = new util.Scope(tempLower, tempUpper); + let result = range.toString(); ``` +### intersect(deprecated) -### isProxy8+ +intersect(range: Scope): Scope -isProxy(value: Object): boolean +获取给定范围和当前范围的交集。 -检查输入的value是否是Proxy类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[intersect9+](#intersect9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4052,29 +3973,35 @@ isProxy(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| range | [Scope](#scopedeprecated) | 是 | 传入一个给定范围。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Proxy类型为true，反之为false。 | +| [Scope](#scopedeprecated) | 返回给定范围和当前范围的交集。 | **示例：** ```js - let that = new util.types(); - const target = {}; - const proxy = new Proxy(target, {}); - let result = that.isProxy(proxy); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let range = new util.Scope(tempLower, tempUpper); + let tempMiDF = new Temperature(35); + let tempMidS = new Temperature(39); + let rangeFir = new util.Scope(tempMiDF, tempMidS); + range.intersect(rangeFir ); ``` +### intersect(deprecated) -### isRegExp8+ +intersect(lowerObj:ScopeType,upperObj:ScopeType):Scope -isRegExp(value: Object): boolean +获取当前范围与给定下限和上限范围的交集。 -检查输入的value是否是RegExp类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[intersect9+](#intersect9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4082,84 +4009,89 @@ isRegExp(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| lowerObj | [ScopeType](#scopetype8) | 是 | 给定范围的下限。 | +| upperObj | [ScopeType](#scopetype8) | 是 | 给定范围的上限。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的RegExp类型为true，反之为false。 | +| [Scope](#scopedeprecated) | 返回当前范围与给定下限和上限范围的交集。 | **示例：** ```js - let that = new util.types(); - let result = that.isRegExp(new RegExp('abc')); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let tempMiDF = new Temperature(35); + let tempMidS = new Temperature(39); + let range = new util.Scope(tempLower, tempUpper); + let result = range.intersect(tempMiDF, tempMidS); ``` +### getUpper(deprecated) -### isSet8+ +getUpper(): ScopeType -isSet(value: Object): boolean +获取当前范围的上限。 -检查输入的value是否是Set类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[getUpper9+](#getupper9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Set类型为true，反之为false。 | +| [ScopeType](#scopetype8) | 返回当前范围的上限值。 | **示例：** ```js - let that = new util.types(); - let result = that.isSet(new Set()); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let range = new util.Scope(tempLower, tempUpper); + let result = range.getUpper(); ``` +### getLower(deprecated) -### isSetIterator8+ +getLower(): ScopeType -isSetIterator(value: Object): boolean +获取当前范围的下限。 -检查输入的value是否是Set的Iterator类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[getLower9+](#getlower9)替代。 **系统能力：** SystemCapability.Utils.Lang -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | - **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Set的Iterator类型为true，反之为false。 | +| [ScopeType](#scopetype8) | 返回当前范围的下限值。 | **示例：** ```js - let that = new util.types(); - const set = new Set(); - let result = that.isSetIterator(set.keys()); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let range = new util.Scope(tempLower, tempUpper); + let result = range.getLower(); ``` +### expand(deprecated) -### isStringObject8+ +expand(lowerObj: ScopeType,upperObj: ScopeType): Scope -isStringObject(value: Object): boolean +创建并返回包括当前范围和给定下限和上限的并集。 -检查输入的value是否是String对象类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[expand9+](#expand9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4167,27 +4099,35 @@ isStringObject(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| lowerObj | [ScopeType](#scopetype8) | 是 | 给定范围的下限。 | +| upperObj | [ScopeType](#scopetype8) | 是 | 给定范围的上限。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的String对象类型为true，反之为false。 | +| [Scope](#scopedeprecated) | 返回当前范围和给定下限和上限的并集。 | **示例：** ```js - let that = new util.types(); - let result = that.isStringObject(new String('foo')); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let tempMiDF = new Temperature(35); + let tempMidS = new Temperature(39); + let range = new util.Scope(tempLower, tempUpper); + let result = range.expand(tempMiDF, tempMidS); ``` +### expand(deprecated) -### isSymbolObjec8+ +expand(range: Scope): Scope -isSymbolObject(value: Object): boolean +创建并返回包括当前范围和给定范围的并集。 -检查输入的value是否是Symbol对象类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[expand9+](#expand9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4195,30 +4135,35 @@ isSymbolObject(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| range | [Scope](#scopedeprecated) | 是 | 传入一个给定范围。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Symbol对象类型为true，反之为false。 | +| [Scope](#scopedeprecated) | 返回包括当前范围和给定范围的并集。 | **示例：** ```js - let that = new util.types(); - const symbols = Symbol('foo'); - let result = that.isSymbolObject(Object(symbols)); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let tempMiDF = new Temperature(35); + let tempMidS = new Temperature(39); + let range = new util.Scope(tempLower, tempUpper); + let rangeFir = new util.Scope(tempMiDF, tempMidS); + let result = range.expand(rangeFir); ``` +### expand(deprecated) -### isTypedArray8+ - -isTypedArray(value: Object): boolean +expand(value: ScopeType): Scope -检查输入的value是否是TypedArray类型的辅助类型。 +创建并返回包括当前范围和给定值的并集。 -TypedArray类型的辅助类型，包括Int8Array、Int16Array、Int32Array、Uint8Array、Uint8ClampedArray、Uint16Array、Uint32Array、Float32Array、Float64Array、DataView。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[expand9+](#expand9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4226,27 +4171,33 @@ TypedArray类型的辅助类型，包括Int8Array、Int16Array、Int32Array、Ui | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| value | [ScopeType](#scopetype8) | 是 | 传入一个给定值。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的TypedArray包含的类型为true，反之为false。 | +| [Scope](#scopedeprecated) | 返回包括当前范围和给定值的并集。 | **示例：** ```js - let that = new util.types(); - let result = that.isTypedArray(new Float64Array([])); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let tempMiDF = new Temperature(35); + let range = new util.Scope(tempLower, tempUpper); + let result = range.expand(tempMiDF); ``` +### contains(deprecated) -### isUint8Array8+ +contains(value: ScopeType): boolean -isUint8Array(value: Object): boolean +检查给定value是否包含在当前范围内。 -检查输入的value是否是Uint8Array数组类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[contains9+](#contains9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4254,27 +4205,33 @@ isUint8Array(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| value | [ScopeType](#scopetype8) | 是 | 传入一个给定值。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Uint8Array数组类型为true，反之为false。 | +| boolean | 如果给定值包含在当前范围内返回true，否则返回false。 | **示例：** ```js - let that = new util.types(); - let result = that.isUint8Array(new Uint8Array([])); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let tempMiDF = new Temperature(35); + let range = new util.Scope(tempLower, tempUpper); + range.contains(tempMiDF); ``` +### contains(deprecated) -### isUint8ClampedArray8+ +contains(range: Scope): boolean -isUint8ClampedArray(value: Object): boolean +检查给定range是否在当前范围内。 -检查输入的value是否是Uint8ClampedArray数组类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[contains9+](#contains9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4282,27 +4239,36 @@ isUint8ClampedArray(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| range | [Scope](#scopedeprecated) | 是 | 传入一个给定范围。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Uint8ClampedArray数组类型为true，反之为false。 | +| boolean | 如果给定范围包含在当前范围内返回true，否则返回false。 | **示例：** ```js - let that = new util.types(); - let result = that.isUint8ClampedArray(new Uint8ClampedArray([])); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let range = new util.Scope(tempLower, tempUpper); + let tempLess = new Temperature(20); + let tempMore = new Temperature(45); + let rangeSec = new util.Scope(tempLess, tempMore); + let result = range.contains(rangeSec); ``` +### clamp(deprecated) -### isUint16Array8+ -isUint16Array(value: Object): boolean +clamp(value: ScopeType): ScopeType -检查输入的value是否是Uint16Array数组类型。 +将给定值限定到当前范围内。 + +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[clamp9+](#clamp9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4310,55 +4276,58 @@ isUint16Array(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| value | [ScopeType](#scopetype8) | 是 | 传入的给定值。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Uint16Array数组类型为true，反之为false。 | +| [ScopeType](#scopetype8) | 如果传入的value小于下限，则返回lowerObj；如果大于上限值则返回upperObj；如果在当前范围内，则返回value。 | **示例：** ```js - let that = new util.types(); - let result = that.isUint16Array(new Uint16Array([])); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let tempMiDF = new Temperature(35); + let range = new util.Scope(tempLower, tempUpper); + let result = range.clamp(tempMiDF); ``` -### isUint32Array8+ - -isUint32Array(value: Object): boolean +## Base64(deprecated) -检查输入的value是否是Uint32Array数组类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[Base64Helper9+](#base64helper9)替代。 -**系统能力：** SystemCapability.Utils.Lang +### constructor(deprecated) -**参数：** +constructor() -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +Base64的构造函数。 -**返回值：** +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[constructor9+](#constructor9)替代。 -| 类型 | 说明 | -| -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Uint32Array数组类型为true，反之为false。 | +**系统能力：** SystemCapability.Utils.Lang **示例：** ```js - let that = new util.types(); - let result = that.isUint32Array(new Uint32Array([])); + let base64 = new util.Base64(); ``` +### encodeSync(deprecated) -### isWeakMap8+ +encodeSync(src: Uint8Array): Uint8Array -isWeakMap(value: Object): boolean +通过输入参数编码后输出对应文本。 -检查输入的value是否是WeakMap类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[encodeSync9+](#encodesync9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4366,27 +4335,31 @@ isWeakMap(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| src | Uint8Array | 是 | 编码输入Uint8数组。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的WeakMap类型为true，反之为false。 | +| Uint8Array | 返回编码后新分配的Uint8数组。 | **示例：** ```js - let that = new util.types(); - let result = that.isWeakMap(new WeakMap()); + let that = new util.Base64(); + let array = new Uint8Array([115,49,51]); + let result = that.encodeSync(array); ``` +### encodeToStringSync(deprecated) -### isWeakSet8+ +encodeToStringSync(src: Uint8Array): string -isWeakSet(value: Object): boolean +通过输入参数编码后输出对应文本。 -检查输入的value是否是WeakSet类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[encodeToStringSync9+](#encodetostringsync9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4394,27 +4367,31 @@ isWeakSet(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| src | Uint8Array | 是 | 编码输入Uint8数组。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的WeakSet类型为true，反之为false。 | +| string | 返回编码后的字符串。 | **示例：** ```js - let that = new util.types(); - let result = that.isWeakSet(new WeakSet()); + let that = new util.Base64(); + let array = new Uint8Array([115,49,51]); + let result = that.encodeToStringSync(array); ``` +### decodeSync(deprecated) -### isBigInt64Array8+ +decodeSync(src: Uint8Array | string): Uint8Array -isBigInt64Array(value: Object): boolean +通过输入参数解码后输出对应文本。 -检查输入的value是否是BigInt64Array类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[decodeSync9+](#decodesync9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4422,27 +4399,31 @@ isBigInt64Array(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| src | Uint8Array \| string | 是 | 解码输入Uint8数组或者字符串。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的BigInt64Array类型为true，反之为false。 | +| Uint8Array | 返回解码后新分配的Uint8数组。 | **示例：** ```js - let that = new util.types(); - let result = that.isBigInt64Array(new BigInt64Array([])); + let that = new util.Base64(); + let buff = 'czEz'; + let result = that.decodeSync(buff); ``` +### encode(deprecated) -### isBigUint64Array8+ +encode(src: Uint8Array): Promise<Uint8Array> -isBigUint64Array(value: Object): boolean +通过输入参数异步编码后输出对应文本。 -检查输入的value是否是BigUint64Array类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[encode9+](#encode9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4450,27 +4431,36 @@ isBigUint64Array(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| src | Uint8Array | 是 | 异步编码输入Uint8数组。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的BigUint64Array类型为true，反之为false。 | +| Promise<Uint8Array> | 返回异步编码后新分配的Uint8数组。 | **示例：** ```js - let that = new util.types(); - let result = that.isBigUint64Array(new BigUint64Array([])); + let that = new util.Base64(); + let array = new Uint8Array([115,49,51]); + let rarray = new Uint8Array([99,122,69,122]); + that.encode(array).then(val=>{ + for (var i = 0; i < rarray.length; i++) { + console.log(val[i].toString()) + } + }) ``` +### encodeToString(deprecated) -### isModuleNamespaceObject8+ +encodeToString(src: Uint8Array): Promise<string> -isModuleNamespaceObject(value: Object): boolean +通过输入参数异步编码后输出对应文本。 -检查输入的value是否是Module Namespace Object类型。 +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[encodeToString9+](#encodetostring9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4478,28 +4468,34 @@ isModuleNamespaceObject(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| src | Uint8Array | 是 | 异步编码输入Uint8数组。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的Module Namespace Object类型为true，反之为false。 | +| Promise<string> | 返回异步编码后的字符串。 | **示例：** ```js - import url from '@ohos.url' - let that = new util.types(); - let result = that.isModuleNamespaceObject(url); + let that = new util.Base64(); + let array = new Uint8Array([115,49,51]); + that.encodeToString(array).then(val=>{ + console.log(val) + }) ``` +### decode(deprecated) -### isSharedArrayBuffer8+ -isSharedArrayBuffer(value: Object): boolean +decode(src: Uint8Array | string): Promise<Uint8Array> -检查输入的value是否是SharedArrayBuffer类型。 +通过输入参数异步解码后输出对应文本。 + +> **说明：** +> +> 从API version 8开始支持，从API version 9开始废弃，建议使用[decode9+](#decode9)替代。 **系统能力：** SystemCapability.Utils.Lang @@ -4507,18 +4503,25 @@ isSharedArrayBuffer(value: Object): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| value | Object | 是 | 待检测对象。 | +| src | Uint8Array \| string | 是 | 异步解码输入Uint8数组或者字符串。 | **返回值：** | 类型 | 说明 | | -------- | -------- | -| boolean | 判断的结果，如果是内置包含的SharedArrayBuffer类型为true，反之为false。 | +| Promise<Uint8Array> | 返回异步解码后新分配的Uint8数组。 | **示例：** ```js - let that = new util.types(); - let result = that.isSharedArrayBuffer(new SharedArrayBuffer(0)); + let that = new util.Base64(); + let array = new Uint8Array([99,122,69,122]); + let rarray = new Uint8Array([115,49,51]); + that.decode(array).then(val=>{ + for (var i = 0; i < rarray.length; i++) { + console.log(val[i].toString()) + } + }) ``` + \ No newline at end of file diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-buffer.md b/zh-cn/application-dev/reference/errorcodes/errorcode-buffer.md deleted file mode 100644 index 6f31b7246041e653701be54dc82c13dbe00a6250..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/errorcodes/errorcode-buffer.md +++ /dev/null @@ -1,55 +0,0 @@ -# buffer错误码 - -## 10200001 参数范围越界错误 - -**错误信息** - -The value of ${param} is out of range. - -**错误描述** - -调用接口时某个参数超出了其正常范围的取值。 - -**可能原因** - -某个参数取值超出可用范围。 - -**处理步骤** - -检查所传参数是否在可用取值范围内。 - -## 10200009 Buffer size 错误 - -**错误信息** - -Buffer size must be a multiple of ${size} - -**错误描述** - -Buffer的长度必须是${size}的整数倍,${size}为16-bits,32-bits或者64-bits。 - -**可能原因** - -Buffer的长度不是${size}的整数倍,${size}为16-bits,32-bits或者64-bits。 - -**处理步骤** - -请检查Buffer的长度值。 - -## 10200013 只读属性设置错误 - -**错误信息** - -Cannot set property ${propertyName} of Buffer which has only a getter. - -**错误描述** - -Buffer的属性${propertyName}只读，不能进行设置。 - -**可能原因** - -将${propertyName}放在了等号左边（即对属性值进行设置）。 - -**处理步骤** - -请检查属性${propertyName}是否在等号左边。 \ No newline at end of file diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-containers.md b/zh-cn/application-dev/reference/errorcodes/errorcode-containers.md deleted file mode 100644 index 836759dc56e1c436f15ff1b2b945c864e4ac1e7e..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/errorcodes/errorcode-containers.md +++ /dev/null @@ -1,75 +0,0 @@ -# containers错误码 - -## 10200012 构造函数调用异常 - -**错误信息** - -The {className}'s constructor cannot be directly invoked. - -**错误描述** - -构造语言容器类的构造方法不支持直接调用。 - -**可能原因** - -调用构造函数时未使用new关键字。 - -**处理步骤** - -检查是否使用直接调用了语言容器类的方法，建议使用new关键字创建语言容器类。 - -## 10200011 传入的this object不是容器类的实例 - -**错误信息** - -The {methodName} method cannot be bound. - -**错误描述** - -调用语言容器类的方法时，传入的this object不是容器类的实例语言，容器类的方法不支持bind。 - -**可能原因** - -容器类的方法不支持bind。 - -**处理步骤** - -1.检查是否使用bind API调用语言容器类的方法。 -2.检查是否把语言容器类的方法赋值给不是语言容器实例的对象来调用。 - -## 10200001 参数范围越界异常 - -**错误信息** - -The parameter value is out of range. - -**错误描述** - -调用接口时某个参数超出了其正常范围的取值。 - -**可能原因** - -该错误码表示范围异常，可能原因某个参数越界异常。 - -**处理步骤** - -请检查所传参数是否在正常取值范围内。 - -## 10200010 容器为空 - -**错误信息** - -The container is empty. - -**错误描述** - -操作的容器为空。 - -**可能原因** - -容器是空的。 - -**处理步骤** - -请先往容器内添加元素。 - diff --git a/zh-cn/application-dev/reference/errorcodes/errorcode-utils.md b/zh-cn/application-dev/reference/errorcodes/errorcode-utils.md new file mode 100644 index 0000000000000000000000000000000000000000..8423abf9d2543cd01fcbe33526bf47ad6cf5a71d --- /dev/null +++ b/zh-cn/application-dev/reference/errorcodes/errorcode-utils.md @@ -0,0 +1,221 @@ +# 语言基础类库错误码 + +## 10200001 参数范围越界错误 + +**错误信息** + +The value of ${param} is out of range. + +**错误描述** + +调用接口时某个参数超出了其正常范围的取值。 + +**可能原因** + +某个参数索引超出可用范围。 + +**处理步骤** + +检查输入参数的索引是否越界。 + +## 10200002 参数解析错误 + +**错误信息** + +Invalid ${param} string. + +**错误描述** + +规范字符串解析失败。 + +**可能原因** + +调用接口时，某个字符串类型的参数为非规范的字符串，导致解析该字符串失败。 + +**处理步骤** + +检查输入字符串的格式。 + +## 10200003 Worker初始化失败 + +**错误信息** + +Worker initialization failure. + +**错误描述** + +调用接口时Worker未能正常初始化。 + +**可能原因** + +1. 创建Worker的数量超出限制。 +2. 设置Worker对象的选择项不正确。 + +**处理步骤** + +1. 检查Worker的数量是否超出8个，如果存在，及时销毁空闲的Worker。 +2. 如果设置WorkerOptions，检查参数类型及其合法性。 + +## 10200004 Worker处于非运行状态 + +**错误信息** + +Worker instance is not running. + +**错误描述** + +调用接口时Worker对象处于非运行状态。 + +**可能原因** + +当调用接口时，Worker实例化对象已经被销毁，或正在被销毁。 + +**处理步骤** + +当调用接口时，确保Worker对象处于正常运行状态，未被执行销毁操作。 + +## 10200005 Worker不支持某API + +**错误信息** + +The invoked API is not supported in workers. + +**错误描述** + +Worker不支持某API。 + +**可能原因** + +调用Worker线程中不支持的API。 + +**处理步骤** + +确保使用Worker线程中支持的API。 + +## 10200006 Worker传输信息序列化异常 + +**错误信息** + +Serializing an uncaught exception failed. + +**错误描述** + +Worker传输信息序列化异常。 + +**可能原因** + +传输信息不属于合法的可序列化对象。 + +**处理步骤** + +确保传输信息属于Worker支持的合法序列化对象。 + +## 10200007 Worker文件路径异常 + +**错误信息** + +The worker file patch is invalid path. + +**错误描述** + +文件路径异常，无法正确加载Worker。 + +**可能原因** + +Worker文件路径异常导致无法正常编译生成合法的worker.abc。 + +**处理步骤** + +确保Worker文件路径符合创建Worker对象的规范，参见API参考中[constructor9+](../apis/js-apis-worker.md#constructor9)接口的示例。 + +## 10200009 Buffer的长度错误 + +**错误信息** + +Buffer size must be a multiple of ${size}. + +**错误描述** + +Buffer的长度错误，不符合要求。 + +**可能原因** + +Buffer的长度错误，不符合要求。Buffer长度要求为size的整数倍。其中size为16-bits、32-bits或者64-bits。 + +**处理步骤** + +确保Buffer长度符合要求。 +Buffer长度要求为size的整数倍。其中size为16-bits、32-bits或者64-bits。 + +## 10200010 容器为空 + +**错误信息** + +The container is empty. + +**错误描述** + +操作的容器为空。 + +**可能原因** + +操作的容器为空，未添加相关元素。 + +**处理步骤** + +确保操作的容器不为空，空容器请先向容器内添加元素。 + +## 10200011 传入的this.object不是容器类的实例 + +**错误信息** + +The {methodName} method cannot be bound. + +**错误描述** + +调用语言容器类的方法时，传入的this.object不是容器类的实例语言，容器类的方法不支持bind。 + +**可能原因** + +容器类的方法不支持bind。 + +**处理步骤** + +1. 检查是否使用bind API调用语言容器类的方法。 +2. 检查是否把语言容器类的方法赋值给不是语言容器实例的对象来调用。 + +## 10200012 构造函数调用异常 + +**错误信息** + +The {className}'s constructor cannot be directly invoked. + +**错误描述** + +构造语言容器类的构造方法不支持直接调用。 + +**可能原因** + +调用构造函数时未使用new关键字。 + +**处理步骤** + +检查是否使用直接调用了语言容器类的方法，建议使用new关键字创建语言容器类。 + +## 10200013 只读属性设置错误 + +**错误信息** + +Cannot set property ${propertyName} of Buffer which has only a getter. + +**错误描述** + +Buffer的属性${propertyName}只读，不能进行设置。 + +**可能原因** + +对Buffer的只读属性进行设置，导致异常。 + +**处理步骤** + +不要对Buffer只读属性进行相关设置。