Skip to content

D
Docs

OpenHarmony / Docs
大约 1 年 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 f2538d1f 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!12461 Modify ets_ Interface description data of util module 

Merge pull request !12461 from 小马奔腾/master
上级 1808eca4 8a70aed3
展开全部 隐藏空白更改
内联 并排
Showing with 1948 addition and 1700 deletion
zh-cn/application-dev/reference/apis/js-apis-convertxml.md
浏览文件 @ f2538d1f
......@@ -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<sup>(deprecated)</sup>
> **说明：**
>
> 从API Version 8开始支持，从API Version 9开始废弃，建议使用[convertToJSObject9+](#converttojsobject9)替代。
convert(xml: string, options?: ConvertOptions) : Object
转换xml文本为JavaScript对象。
> **说明：**
>
> 从API version 8开始支持，从API version 9开始废弃，建议使用[convertToJSObject<sup>9+</sup>](#converttojsobject9)替代。
**系统能力：** SystemCapability.Utils.Lang
**参数：**
......
zh-cn/application-dev/reference/apis/js-apis-uri.md
浏览文件 @ f2538d1f
......@@ -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<sup>(deprecated)</sup>
> **说明：**
>
> 从API version 8开始支持，从API version 9开始废弃，建议使用[equalsTo<sup>9+</sup>](#equalsto9)替代。
equals(other: URI): boolean
判断此URI是否与其他URI对象相等。
> **说明：**
>
> 从API version 8开始支持，从API version 9开始废弃，建议使用[equalsTo<sup>9+</sup>](#equalsto9)替代。
**系统能力：** SystemCapability.Utils.Lang
**参数：**
......
zh-cn/application-dev/reference/apis/js-apis-url.md
浏览文件 @ f2538d1f
......@@ -366,18 +366,148 @@ params.append('fod', '3');
console.log(params.toString());
```
## URLSearchParams<sup>(deprecated)</sup>
## 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<sup>(deprecated)</sup>
constructor(url: string, base?: string | URL)
URL的构造函数。
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>](#constructor9+)替代。
> 从API version 7开始支持，从API version 9开始废弃，建议使用[parseURL<sup>9+</sup>](#parseurl9)替代。
**系统能力：** SystemCapability.Utils.Lang
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| url | string | 是 | 入参对象。 |
| base | string \| URL | 否 | 入参字符串或者对象。<br/>- string：字符串<br/>- 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/
```
### parseURL<sup>9+</sup>
static parseURL(url : string, base?: string | URL): URL
URL静态成员函数。
**系统能力：** SystemCapability.Utils.Lang
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| url | string | 是 | 入参对象。 |
| base | string \| URL | 否 | 入参字符串或者对象。<br/>- string：字符串<br/>- 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<sup>(deprecated)</sup>
### constructor<sup>(deprecated)</sup>
constructor(init?: string[][] | Record&lt;string, string&gt; | string | URLSearchParams)
URLSearchParams的构造函数。
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>](#constructor9)替代。
**系统能力：** SystemCapability.Utils.Lang
**参数：**
......@@ -398,14 +528,14 @@ let params = new Url.URLSearchParams(urlObject.search);
### append<sup>(deprecated)</sup>
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>.append<sup>9+</sup>](#append9)替代。
append(name: string, value: string): void
将新的键值对插入到查询字符串。
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>.append<sup>9+</sup>](#append9)替代。
**系统能力：** SystemCapability.Utils.Lang
**参数：**
......@@ -425,14 +555,14 @@ paramsObject.append('fod', '3');
### delete<sup>(deprecated)</sup>
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>.delete<sup>9+</sup>](#delete9)替代。
delete(name: string): void
删除指定名称的键值对。
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>.delete<sup>9+</sup>](#delete9)替代。
**系统能力：** SystemCapability.Utils.Lang
**参数：**
......@@ -451,14 +581,14 @@ paramsobject.delete('fod');
### getAll<sup>(deprecated)</sup>
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>.getAll<sup>9+</sup>](#getall9)替代。
getAll(name: string): string[]
获取指定名称的所有键值对。
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>.getAll<sup>9+</sup>](#getall9)替代。
**系统能力：** SystemCapability.Utils.Lang
**参数：**
......@@ -484,14 +614,14 @@ console.log(params.getAll('fod').toString()) // Output ["1","3"].
### entries<sup>(deprecated)</sup>
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>.entries<sup>9+</sup>](#entries9)替代。
entries(): IterableIterator<[string, string]>
返回一个ES6的迭代器，迭代器的每一项都是一个 JavaScript Array。Array的第一项是name，Array的第二项是value。
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>.entries<sup>9+</sup>](#entries9)替代。
**系统能力：** SystemCapability.Utils.Lang
**返回值：**
......@@ -511,14 +641,15 @@ for (var pair of searchParamsObject .entries()) { // Show keyName/valueName pair
### forEach<sup>(deprecated)</sup>
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>.forEach<sup>9+</sup>](#foreach9)替代。
forEach(callbackFn: (value: string, key: string, searchParams: this) => void, thisArg?: Object): void
通过回调函数来遍历URLSearchParams实例对象上的键值对。
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>.forEach<sup>9+</sup>](#foreach9)替代。
**系统能力：** SystemCapability.Utils.Lang
**参数：**
......@@ -547,14 +678,15 @@ myURLObject.searchParams.forEach((value, name, searchParams) => {
### get<sup>(deprecated)</sup>
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>.get<sup>9+</sup>](#get9)替代。
get(name: string): string | null
获取指定名称对应的第一个值。
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>.get<sup>9+</sup>](#get9)替代。
**系统能力：** SystemCapability.Utils.Lang
**参数：**
......@@ -580,14 +712,15 @@ let age = parseInt(paramsObject.get("age"), 10); // is the number 18
### has<sup>(deprecated)</sup>
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>.has<sup>9+</sup>](#has9)替代。
has(name: string): boolean
判断一个指定的键名对应的值是否存在。
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>.has<sup>9+</sup>](#has9)替代。
**系统能力：** SystemCapability.Utils.Lang
**参数：**
......@@ -612,14 +745,15 @@ paramsObject.has('bard') === true;
### set<sup>(deprecated)</sup>
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>.set<sup>9+</sup>](#set9)替代。
set(name: string, value: string): void
将与name关联的URLSearchParams对象中的值设置为value。如果存在名称为name的键值对，请将第一个键值对的值设置为value并删除所有其他值。如果不是，则将键值对附加到查询字符串。
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>.set<sup>9+</sup>](#set9)替代。
**系统能力：** SystemCapability.Utils.Lang
**参数：**
......@@ -639,14 +773,15 @@ paramsObject.set('baz', '3'); // Add a third parameter.
### sort<sup>(deprecated)</sup>
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>.sort<sup>9+</sup>](#sort9)替代。
sort(): void
对包含在此对象中的所有键值对进行排序，并返回undefined。排序顺序是根据键的Unicode代码点。该方法使用稳定的排序算法 （即，将保留具有相等键的键值对之间的相对顺序）。
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>.sort<sup>9+</sup>](#sort9)替代。
**系统能力：** SystemCapability.Utils.Lang
**示例：**
......@@ -659,14 +794,15 @@ console.log(searchParamsObject.toString()); // Display the sorted query string /
### keys<sup>(deprecated)</sup>
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>.keys<sup>9+</sup>](#keys9)替代。
keys(): IterableIterator&lt;string&gt;
返回一个所有键值对的name的ES6迭代器。
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>.keys<sup>9+</sup>](#keys9)替代。
**系统能力：** SystemCapability.Utils.Lang
**返回值：**
......@@ -686,14 +822,15 @@ for (var key of searchParamsObject .keys()) { // Output key-value pairs
### values<sup>(deprecated)</sup>
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>.values<sup>9+</sup>](#values9)替代。
values(): IterableIterator&lt;string&gt;
返回一个所有键值对的value的ES6迭代器。
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[URLParams<sup>9+</sup>.values<sup>9+</sup>](#values9)替代。
**系统能力：** SystemCapability.Utils.Lang
**返回值：**
......@@ -714,14 +851,14 @@ for (var value of searchParams.values()) {
### [Symbol.iterator]<sup>(deprecated)</sup>
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[[Symbol.iterator]<sup>9+</sup>](#symboliterator9)替代。
[Symbol.iterator]\(): IterableIterator&lt;[string, string]&gt;
返回一个ES6的迭代器，迭代器的每一项都是一个 JavaScript Array。Array的第一项是name，Array的第二项是value。
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[[Symbol.iterator]<sup>9+</sup>](#symboliterator9)替代。
**系统能力：** SystemCapability.Utils.Lang
**返回值：**
......@@ -740,14 +877,15 @@ for (const [name, value] of paramsObject) {
```
### tostring<sup>(deprecated)</sup>
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[tostring<sup>9+</sup>](#tostring9)替代。
toString(): string
返回序列化为字符串的搜索参数，必要时对字符进行百分比编码。
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃，建议使用[tostring<sup>9+</sup>](#tostring9)替代。
**系统能力：** SystemCapability.Utils.Lang
**返回值：**
......
zh-cn/application-dev/reference/errorcodes/errorcode-buffer.md 已删除 100644 → 0
浏览文件 @ 1808eca4
# 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
zh-cn/application-dev/reference/errorcodes/errorcode-containers.md 已删除 100644 → 0
浏览文件 @ 1808eca4
# 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.
**错误描述**
操作的容器为空。
**可能原因**
容器是空的。
**处理步骤**
请先往容器内添加元素。
zh-cn/application-dev/reference/errorcodes/errorcode-utils.md 0 → 100644
浏览文件 @ f2538d1f
# 语言基础类库错误码
## 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参考中[constructor<sup>9+</sup>](../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只读属性进行相关设置。
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或