提交 53927993 编写于 作者: Z zWX1234017

补充util模块部分接口可选参数默认值说明,xml模块示例代码修改

Signed-off-by: NzWX1234017 <zhaoduwei3@huawei.com>
上级 c72f3559
......@@ -379,15 +379,15 @@ thisArg?: Object): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callbackFn | function | 是 | 回调函数。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值,默认值为当前实例对象。 |
callbackfn的参数说明:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素。 |
| index | number | 否 | 当前遍历到的下标值。 |
| arrlist | ArrayList&lt;T&gt; | 否 | 当前调用replaceAllElements方法的实例对象。 |
| index | number | 否 | 当前遍历到的下标值,默认值为0。 |
| arrlist | ArrayList&lt;T&gt; | 否 | 当前调用replaceAllElements方法的实例对象,默认值为当前实例对象。 |
**错误码:**
......@@ -425,15 +425,15 @@ thisArg?: Object): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callbackFn | function | 是 | 回调函数。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值,默认值为当前实例对象。 |
callbackfn的参数说明:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素。 |
| index | number | 否 | 当前遍历到的下标值。 |
| arrlist | ArrayList&lt;T&gt; | 否 | 当前调用forEach方法的实例对象。 |
| index | number | 否 | 当前遍历到的下标值,默认值为0。 |
| arrlist | ArrayList&lt;T&gt; | 否 | 当前调用forEach方法的实例对象,默认值为当前实例对象。 |
**错误码:**
......@@ -468,7 +468,7 @@ sort(comparator?: (firstValue: T, secondValue: T) => number): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| comparator | function | 否 | 回调函数。 |
| comparator | function | 否 | 回调函数,默认为升序排序的回调函数。 |
comparator的参数说明:
......
......@@ -204,7 +204,7 @@ concat(list: Buffer[] | Uint8Array[], totalLength?: number): Buffer
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| list | Buffer[]&nbsp;\|&nbsp;Uint8Array[] | 是 | 实例数组。 |
| totalLength | number | 否 | 需要复制的总字节长度。 |
| totalLength | number | 否 | 需要复制的总字节长度,默认值为0。 |
**返回值:**
......
......@@ -242,15 +242,15 @@ thisArg?: Object): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callbackFn | function | 是 | 回调函数。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值,默认值为当前实例对象。 |
callbackfn的参数说明:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素。 |
| index | number | 否 | 当前遍历到的下标值。 |
| deque | Deque&lt;T&gt; | 否 | 当前调用forEach方法的实例对象。 |
| index | number | 否 | 当前遍历到的下标值,默认值为0。 |
| deque | Deque&lt;T&gt; | 否 | 当前调用forEach方法的实例对象,默认值为当前实例对象。 |
**错误码:**
......
......@@ -459,14 +459,14 @@ forEach(callbackFn: (value?: V, key?: K, map?: HashMap<K, V>) => void, thisArg?:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callbackFn | function | 是 | 回调函数。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值,默认值为当前实例对象。 |
callbackfn的参数说明:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | V | 否 | 当前遍历到的元素键值对的值。 |
| key | K | 否 | 当前遍历到的元素键值对的键。 |
| map | HashMap<K, V> | 否 | 当前调用forEach方法的实例对象。 |
| value | V | 否 | 当前遍历到的元素键值对的值,默认值为首个键值对的值。 |
| key | K | 否 | 当前遍历到的元素键值对的键,默认值为首个键值对的键。 |
| map | HashMap<K, V> | 否 | 当前调用forEach方法的实例对象,默认值为当前实例对象。 |
**错误码:**
......
......@@ -282,14 +282,14 @@ forEach(callbackFn: (value?: T, key?: T, set?: HashSet&lt;T&gt;) => void, thisAr
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callbackFn | function | 是 | 回调函数。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值,默认值为当前实例对象。 |
callbackfn的参数说明:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | T | 否 | 当前遍历到的元素键值对的值。 |
| key | T | 否 | 当前遍历到的元素键值对的值(和value相同)。 |
| set | HashSet&lt;T&gt; | 否 | 当前调用forEach方法的实例对象。 |
| value | T | 否 | 当前遍历到的元素键值对的值,默认值为首个键值对的值。 |
| key | T | 否 | 当前遍历到的元素键值对的键(和value相同),默认值为首个键值对的键。 |
| set | HashSet&lt;T&gt; | 否 | 当前调用forEach方法的实例对象,默认值为当前实例对象。 |
**错误码:**
......
......@@ -724,14 +724,14 @@ forEach(callbackFn: (value?: V, key?: K, map?: LightWeightMap<K, V>) => void, th
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callbackFn | function | 是 | 回调函数。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值,默认值为当前实例对象。 |
callbackfn的参数说明:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | V | 否 | 当前遍历到的元素键值对的值。 |
| key | K | 否 | 当前遍历到的元素键值对的键。 |
| map | LightWeightMap<K, V> | 否 | 当前调用forEach方法的实例对象。 |
| value | V | 否 | 当前遍历到的元素键值对的值,默认值为首个键值对的值。 |
| key | K | 否 | 当前遍历到的元素键值对的键,默认值为首个键值对的键。 |
| map | LightWeightMap<K, V> | 否 | 当前调用forEach方法的实例对象,默认值为当前实例对象。 |
**错误码:**
......
......@@ -588,14 +588,14 @@ forEach(callbackFn: (value?: T, key?: T, set?: LightWeightSet&lt;T&gt;) => void,
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callbackFn | function | 是 | 回调函数。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值,默认值为当前实例对象。 |
callbackfn的参数说明:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | T | 否 | 当前遍历到的元素。 |
| key | T | 否 | 当前遍历到的元素(和value相同)。 |
| set | LightWeightSet&lt;T&gt; | 否 | 当前调用forEach方法的实例对象。 |
| value | T | 否 | 当前遍历到的元素键值对的值,默认值为首个键值对的值。 |
| key | T | 否 | 当前遍历到的元素键值对的键(和value相同),默认值为首个键值对的键。 |
| set | LightWeightSet&lt;T&gt; | 否 | 当前调用forEach方法的实例对象,默认值为当前实例对象。 |
**错误码:**
......
......@@ -607,15 +607,15 @@ thisArg?: Object): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callbackFn | function | 是 | 回调函数。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值,默认值为当前实例对象。 |
callbackfn的参数说明:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素。 |
| index | number | 否 | 当前遍历到的下标值。 |
| LinkedList | LinkedList&lt;T&gt; | 否 | 当前调用forEach方法的实例对象。 |
| index | number | 否 | 当前遍历到的下标值,默认值为0。 |
| LinkedList | LinkedList&lt;T&gt; | 否 | 当前调用forEach方法的实例对象,默认值为当前实例对象。 |
**错误码:**
......
......@@ -427,15 +427,15 @@ thisArg?: Object): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callbackFn | function | 是 | 回调函数。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值,默认值为当前实例对象。 |
callbackfn的参数说明:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素。 |
| index | number | 否 | 当前遍历到的下标值。 |
| list | List&lt;T&gt; | 否 | 当前调用replaceAllElements方法的实例对象。 |
| index | number | 否 | 当前遍历到的下标值,默认值为0。 |
| list | List&lt;T&gt; | 否 | 当前调用replaceAllElements方法的实例对象,默认值为当前实例对象。 |
**错误码:**
......@@ -473,15 +473,15 @@ thisArg?: Object): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callbackFn | function | 是 | 回调函数。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值,默认值为当前实例对象。 |
callbackfn的参数说明:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素。 |
| index | number | 否 | 当前遍历到的下标值。 |
| List | List&lt;T&gt; | 否 | 当前调用forEach方法的实例对象。 |
| index | number | 否 | 当前遍历到的下标值,默认值为0。 |
| List | List&lt;T&gt; | 否 | 当前调用forEach方法的实例对象,默认值为当前实例对象。 |
**错误码:**
......
......@@ -597,14 +597,14 @@ forEach(callbackFn: (value: T, index?: number, PlainArray?: PlainArray&lt;T&gt;)
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callbackFn | function | 是 | 回调函数。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值,默认值为当前实例对象。 |
callbackfn的参数说明:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素键值对的值。 |
| index | number | 否 | 当前遍历到的元素键值对的键。 |
| PlainArray | PlainArray&lt;T&gt;| 否 | 当前调用forEach方法的实例对象。 |
| value | T | 是 | 当前遍历到的元素。 |
| index | number | 否 | 当前遍历到的下标值,默认值为0。 |
| PlainArray | PlainArray&lt;T&gt;| 否 | 当前调用forEach方法的实例对象,默认值为当前实例对象。 |
**错误码:**
......
......@@ -176,15 +176,15 @@ thisArg?: Object): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callbackFn | function | 是 | 回调函数。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值,默认值为当前实例对象。 |
callbackfn的参数说明:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素。 |
| index | number | 否 | 当前遍历到的下标值。 |
| Queue | Queue&lt;T&gt; | 否 | 当前调用forEach方法的实例对象。 |
| index | number | 否 | 当前遍历到的下标值,默认值为0。 |
| Queue | Queue&lt;T&gt; | 否 | 当前调用forEach方法的实例对象,默认值为当前实例对象。 |
**错误码:**
......
......@@ -214,15 +214,15 @@ thisArg?: Object): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callbackFn | function | 是 | 回调函数。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值,默认值为当前实例对象。 |
callbackfn的参数说明:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素。 |
| index | number | 否 | 当前遍历到的下标值。 |
| stack | Stack&lt;T&gt; | 否 | 当前调用forEach方法的实例对象。 |
| index | number | 否 | 当前遍历到的下标值,默认值为0。 |
| stack | Stack&lt;T&gt; | 否 | 当前调用forEach方法的实例对象,默认值为当前实例对象。 |
**错误码:**
......
......@@ -48,7 +48,7 @@ TreeMap的构造函数。
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| comparator | function | 否 | 用户自定义的比较函数。 |
| comparator | function | 否 | 用户自定义的比较函数,默认值为hole(一个空白占位符),表示没有提供比较函数。 |
**错误码:**
......@@ -611,14 +611,14 @@ forEach(callbackFn: (value?: V, key?: K, map?: TreeMap<K, V>) => void, thisArg?:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callbackFn | function | 是 | 回调函数。 |
| thisArg | Object | 否 | callbackFn被调用时用作this值。 |
| thisArg | Object | 否 | callbackFn被调用时用作this值,默认值为当前实例对象。 |
callbackFn的参数说明:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | V | 否 | 当前遍历到的元素键值对的值。 |
| key | K | 否 | 当前遍历到的元素键值对的键。 |
| map | TreeMap<K, V> | 否 | 当前调用forEach方法的实例对象。 |
| value | V | 否 | 当前遍历到的元素键值对的值,默认值为首个键值对的值。 |
| key | K | 否 | 当前遍历到的元素键值对的键,默认值为首个键值对的键。 |
| map | TreeMap<K, V> | 否 | 当前调用forEach方法的实例对象,默认值为当前实例对象。 |
**错误码:**
......
......@@ -44,7 +44,7 @@ TreeSet的构造函数。
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| comparator | function | 否 | 用户自定义的比较函数。 |
| comparator | function | 否 | 用户自定义的比较函数,默认值为hole(一个空白占位符),表示没有提供比较函数。 |
**错误码:**
......@@ -484,14 +484,14 @@ forEach(callbackFn: (value?: T, key?: T, set?: TreeSet&lt;T&gt;) => void, thisAr
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callbackFn | function | 是 | 回调函数。 |
| thisArg | Object | 否 | callbackFn被调用时用作this值。 |
| thisArg | Object | 否 | callbackFn被调用时用作this值,默认值为当前实例对象。 |
callbackFn的参数说明:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | T | 否 | 当前遍历到的value元素。 |
| key | T | 否 | 当前遍历到的key元素。 |
| set | TreeSet&lt;T&gt; | 否 | 当前调用forEach方法的实例对象。 |
| value | T | 否 | 当前遍历到的value元素,默认值为首个键值对的值。 |
| key | T | 否 | 当前遍历到的key元素,默认值为首个键值对的键。 |
| set | TreeSet&lt;T&gt; | 否 | 当前调用forEach方法的实例对象,默认值为当前实例对象。 |
**错误码:**
......
......@@ -586,7 +586,7 @@ result = textEncoder.encodeInto("\uD800¥¥");
### encodeIntoUint8Array<sup>9+</sup>
encodeIntoUint8Array(input: string, dest: Uint8Array, ): { read: number; written: number }
encodeIntoUint8Array(input: string, dest: Uint8Array): { read: number; written: number }
放置生成的UTF-8编码文本。
......@@ -617,7 +617,7 @@ result = that.encodeIntoUint8Array('abcd', dest)
### encodeInto<sup>(deprecated)</sup>
encodeInto(input: string, dest: Uint8Array, ): { read: number; written: number }
encodeInto(input: string, dest: Uint8Array): { read: number; written: number }
放置生成的UTF-8编码文本。
......@@ -1100,7 +1100,7 @@ constructor(capacity?: number)
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---------------------------- |
| capacity | number | 否 | 指示要为缓冲区自定义的容量。 |
| capacity | number | 否 | 指示要为缓冲区自定义的容量,默认值为64。 |
**示例:**
......@@ -3400,7 +3400,7 @@ constructor(capacity?: number)
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| capacity | number | 否 | 指示要为缓冲区自定义的容量。 |
| capacity | number | 否 | 指示要为缓冲区自定义的容量,默认值为64。 |
**示例:**
......
......@@ -304,15 +304,15 @@ thisArg?: Object): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callbackFn | function | 是 | 回调函数。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值,默认值为当前实例对象。 |
callbackfn的参数说明:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素。 |
| index | number | 否 | 当前遍历到的下标值。 |
| vector | Vector&lt;T&gt; | 否 | 当前调用replaceAllElements方法的实例对象。 |
| index | number | 否 | 当前遍历到的下标值,默认值为0。 |
| vector | Vector&lt;T&gt; | 否 | 当前调用replaceAllElements方法的实例对象,默认值为当前实例对象。 |
**示例:**
......@@ -342,15 +342,15 @@ thisArg?: Object): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callbackFn | function | 是 | 回调函数。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值,默认值为当前实例对象。 |
callbackfn的参数说明:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素。 |
| index | number | 否 | 当前遍历到的下标值。 |
| vector | Vector&lt;T&gt; | 否 | 当前调用forEach方法的实例对象。 |
| index | number | 否 | 当前遍历到的下标值,默认值为0。 |
| vector | Vector&lt;T&gt; | 否 | 当前调用forEach方法的实例对象,默认值为当前实例对象。 |
**示例:**
......@@ -378,7 +378,7 @@ sort(comparator?: (firstValue: T, secondValue: T) => number): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| comparator | function | 否 | 回调函数。 |
| comparator | function | 否 | 回调函数,默认值为当前实例对象。 |
comparator的参数说明:
......
......@@ -380,6 +380,7 @@ constructor(buffer: ArrayBuffer | DataView, encoding?: string)
**示例:**
```js
import util from '@ohos.util';
let strXml =
'<?xml version="1.0" encoding="utf-8"?>' +
'<!DOCTYPE note [\n<!ENTITY foo "baa">]>' +
......@@ -431,6 +432,7 @@ parse(option: ParseOptions): void
**示例:**
```js
import util from '@ohos.util';
let strXml =
'<?xml version="1.0" encoding="utf-8"?>' +
'<note importance="high" logged="true">' +
......@@ -498,6 +500,7 @@ getColumnNumber(): number
**示例:**
```js
import util from '@ohos.util';
let strXml =
'<?xml version="1.0" encoding="utf-8"?>' +
'<note importance="high" logged="true">' +
......@@ -541,6 +544,7 @@ getDepth(): number
**示例:**
```js
import util from '@ohos.util';
let strXml =
'<?xml version="1.0" encoding="utf-8"?>' +
'<note importance="high" logged="true">' +
......@@ -587,6 +591,7 @@ getLineNumber(): number
**示例:**
```js
import util from '@ohos.util';
let strXml =
'<?xml version="1.0" encoding="utf-8"?>' +
'<note importance="high" logged="true">' +
......@@ -630,6 +635,7 @@ getName(): string
**示例:**
```js
import util from '@ohos.util';
let strXml =
'<?xml version="1.0" encoding="utf-8"?>' +
'<note importance="high" logged="true">' +
......@@ -672,6 +678,7 @@ getNamespace(): string
**示例:**
```js
import util from '@ohos.util';
let strXml =
'<?xml version="1.0" encoding="utf-8"?>' +
'<note importance="high" logged="true">' +
......@@ -714,6 +721,7 @@ getPrefix(): string
**示例:**
```js
import util from '@ohos.util';
let strXml =
'<?xml version="1.0" encoding="utf-8"?>' +
'<note importance="high" logged="true">' +
......@@ -757,6 +765,7 @@ getText(): string
**示例:**
```js
import util from '@ohos.util';
let strXml =
'<?xml version="1.0" encoding="utf-8"?>' +
'<note importance="high" logged="true">' +
......@@ -799,6 +808,7 @@ isEmptyElementTag(): boolean
**示例:**
```js
import util from '@ohos.util';
let strXml =
'<?xml version="1.0" encoding="utf-8"?>' +
'<note importance="high" logged="true">' +
......@@ -841,6 +851,7 @@ isWhitespace(): boolean
**示例:**
```js
import util from '@ohos.util';
let strXml =
'<?xml version="1.0" encoding="utf-8"?>' +
'<note importance="high" logged="true">' +
......@@ -882,6 +893,7 @@ getAttributeCount(): number
**示例:**
```js
import util from '@ohos.util';
let strXml =
'<?xml version="1.0" encoding="utf-8"?>' +
'<note importance="high" logged="true">' +
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册