Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
2a44c05c
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
2a44c05c
编写于
1月 13, 2023
作者:
O
openharmony_ci
提交者:
Gitee
1月 13, 2023
浏览文件
操作
浏览文件
下载
差异文件
!13451 增加缺失的构造函数,增加type说明,修改部分函数示例代码
Merge pull request !13451 from jwx1068251/master
上级
219d13b6
f60e5fec
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
125 addition
and
82 deletion
+125
-82
zh-cn/application-dev/reference/apis/js-apis-util.md
zh-cn/application-dev/reference/apis/js-apis-util.md
+125
-82
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-util.md
浏览文件 @
2a44c05c
...
@@ -64,7 +64,7 @@ errnoToString(errno: number): string
...
@@ -64,7 +64,7 @@ errnoToString(errno: number): string
**示例:**
**示例:**
```
js
```
js
let
errnum
=
10
;
// 10
: a system error number
let
errnum
=
-
1
;
// -1
: a system error number
let
result
=
util
.
errnoToString
(
errnum
);
let
result
=
util
.
errnoToString
(
errnum
);
console
.
log
(
"
result =
"
+
result
);
console
.
log
(
"
result =
"
+
result
);
```
```
...
@@ -286,7 +286,7 @@ getErrorString(errno: number): string
...
@@ -286,7 +286,7 @@ getErrorString(errno: number): string
**示例:**
**示例:**
```
js
```
js
let
errnum
=
10
;
// 10
: a system error number
let
errnum
=
-
1
;
// -1
: a system error number
let
result
=
util
.
getErrorString
(
errnum
);
let
result
=
util
.
getErrorString
(
errnum
);
console
.
log
(
"
result =
"
+
result
);
console
.
log
(
"
result =
"
+
result
);
```
```
...
@@ -338,7 +338,7 @@ TextDecoder的构造函数。
...
@@ -338,7 +338,7 @@ TextDecoder的构造函数。
### create<sup>9+</sup>
### create<sup>9+</sup>
create(encoding?: string,options?: { fatal?: boolean; ignoreBOM?: boolean }
,
): TextDecoder;
create(encoding?: string,options?: { fatal?: boolean; ignoreBOM?: boolean }): TextDecoder;
替代有参构造功能。
替代有参构造功能。
...
@@ -365,9 +365,9 @@ let textDecoder = new util.TextDecoder()
...
@@ -365,9 +365,9 @@ let textDecoder = new util.TextDecoder()
textDecoder
.
create
(
'
utf-8
'
,
{
ignoreBOM
:
true
});
textDecoder
.
create
(
'
utf-8
'
,
{
ignoreBOM
:
true
});
```
```
### decode
### decode
WithStream<sup>9+</sup>
decode
(input: Uint8Array, options?: { stream?: false
}): string
decode
WithStream(input: Uint8Array, options?: { stream?: boolean
}): string
通过输入参数解码后输出对应文本。
通过输入参数解码后输出对应文本。
...
@@ -384,7 +384,7 @@ decode(input: Uint8Array, options?: { stream?: false }): string
...
@@ -384,7 +384,7 @@ decode(input: Uint8Array, options?: { stream?: false }): string
| 名称 | 参数类型 | 必填 | 说明 |
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| stream | boolean | 否 | 在随后的decode()调用中是否跟随附加数据块。如果以块的形式处理数据,则设置为true;如果处理最后的数据块或数据未分块,则设置为false。默认为false。 |
| stream | boolean | 否 | 在随后的decode
WithStream
()调用中是否跟随附加数据块。如果以块的形式处理数据,则设置为true;如果处理最后的数据块或数据未分块,则设置为false。默认为false。 |
**返回值:**
**返回值:**
...
@@ -404,16 +404,19 @@ decode(input: Uint8Array, options?: { stream?: false }): string
...
@@ -404,16 +404,19 @@ decode(input: Uint8Array, options?: { stream?: false }): string
result
[
4
]
=
0x62
;
result
[
4
]
=
0x62
;
result
[
5
]
=
0x63
;
result
[
5
]
=
0x63
;
console
.
log
(
"
input num:
"
);
console
.
log
(
"
input num:
"
);
let
retStr
=
textDecoder
.
decode
(
result
,
{
stream
:
false
});
let
retStr
=
textDecoder
.
decode
WithStream
(
result
,
{
stream
:
false
});
console
.
log
(
"
retStr =
"
+
retStr
);
console
.
log
(
"
retStr =
"
+
retStr
);
```
```
### constructor<sup>(deprecated)</sup>
### decodeWithStream<sup>9+</sup>
constructor(encoding?: string, options?: { fatal?: boolean; ignoreBOM?: boolean })
decodeWithStream(input: Uint8Array, options?: { stream?: boolean }): string
TextDecoder的构造函数。
通过输入参数解码后输出对应文本。
> **说明:**
>
> 从API version 7开始支持,从API version 9开始废弃,建议使用[create<sup>9+</sup>](#create9)替代。
**系统能力:**
SystemCapability.Utils.Lang
**系统能力:**
SystemCapability.Utils.Lang
...
@@ -421,46 +424,31 @@ decodeWithStream(input: Uint8Array, options?: { stream?: boolean }): string
...
@@ -421,46 +424,31 @@ decodeWithStream(input: Uint8Array, options?: { stream?: boolean }): string
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
|
input | Uint8Array | 是 | 符合格式需要解码的数组
。 |
|
encoding | string | 否 | 编码格式
。 |
| options | Object | 否 |
解码相关选项参数
。 |
| options | Object | 否 |
编码相关选项参数,存在两个属性fatal和ignoreBOM
。 |
**表2
**
options
**表1
**
options
| 名称 | 参数类型 | 必填 | 说明 |
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| stream | boolean | 否 | 在随后的decodeWithStream()调用中是否跟随附加数据块。如果以块的形式处理数据,则设置为true;如果处理最后的数据块或数据未分块,则设置为false。默认为false。 |
| fatal | boolean | 否 | 是否显示致命错误。 |
| ignoreBOM | boolean | 否 | 是否忽略BOM标记。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| string | 解码后的数据。 |
**示例:**
**示例:**
```
js
```
js
let
textDecoder
=
new
util
.
TextDecoder
(
"
utf-8
"
,{
ignoreBOM
:
true
});
let
textDecoder
=
new
util
.
TextDecoder
(
"
utf-8
"
,{
ignoreBOM
:
true
});
let
result
=
new
Uint8Array
(
6
);
result
[
0
]
=
0xEF
;
result
[
1
]
=
0xBB
;
result
[
2
]
=
0xBF
;
result
[
3
]
=
0x61
;
result
[
4
]
=
0x62
;
result
[
5
]
=
0x63
;
console
.
log
(
"
input num:
"
);
let
retStr
=
textDecoder
.
decodeWithStream
(
result
,
{
stream
:
false
});
console
.
log
(
"
retStr =
"
+
retStr
);
```
```
###
constructor
<sup>(deprecated)</sup>
###
decode
<sup>(deprecated)</sup>
constructor(encoding?: string, options?: { fatal?: boolean; ignoreBOM?: boolean },)
decode(input: Uint8Array, options?: { stream?: false }): string
TextDecoder的构造函数
。
通过输入参数解码后输出对应文本
。
> **说明:**
> **说明:**
>
>
> 从API version 7开始支持,从API version 9开始废弃,建议使用[
constructor<sup>9+</sup>](#constructor
9)替代。
> 从API version 7开始支持,从API version 9开始废弃,建议使用[
decodeWithStream<sup>9+</sup>](#decodewithstream
9)替代。
**系统能力:**
SystemCapability.Utils.Lang
**系统能力:**
SystemCapability.Utils.Lang
...
@@ -468,20 +456,35 @@ TextDecoder的构造函数。
...
@@ -468,20 +456,35 @@ TextDecoder的构造函数。
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
|
encoding | string | 否 | 编码格式
。 |
|
input | Uint8Array | 是 | 符合格式需要解码的数组
。 |
| options | Object | 否 |
编码相关选项参数,存在两个属性fatal和ignoreBOM
。 |
| options | Object | 否 |
解码相关选项参数
。 |
**表1
**
options
**表2
**
options
| 名称 | 参数类型 | 必填 | 说明 |
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| fatal | boolean | 否 | 是否显示致命错误。 |
| stream | boolean | 否 | 在随后的decode()调用中是否跟随附加数据块。如果以块的形式处理数据,则设置为true;如果处理最后的数据块或数据未分块,则设置为false。默认为false。 |
| ignoreBOM | boolean | 否 | 是否忽略BOM标记。 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| string | 解码后的数据。 |
**示例:**
**示例:**
```
js
```
js
let
textDecoder
=
new
util
.
TextDecoder
(
"
utf-8
"
,{
ignoreBOM
:
true
});
let
textDecoder
=
new
util
.
TextDecoder
(
"
utf-8
"
,{
ignoreBOM
:
true
});
let
result
=
new
Uint8Array
(
6
);
result
[
0
]
=
0xEF
;
result
[
1
]
=
0xBB
;
result
[
2
]
=
0xBF
;
result
[
3
]
=
0x61
;
result
[
4
]
=
0x62
;
result
[
5
]
=
0x63
;
console
.
log
(
"
input num:
"
);
let
retStr
=
textDecoder
.
decode
(
result
,
{
stream
:
false
});
console
.
log
(
"
retStr =
"
+
retStr
);
```
```
## TextEncoder
## TextEncoder
...
@@ -494,7 +497,6 @@ TextDecoder的构造函数。
...
@@ -494,7 +497,6 @@ TextDecoder的构造函数。
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| encoding | string | 是 | 否 | 编码格式,默认值是utf-8。 |
| encoding | string | 是 | 否 | 编码格式,默认值是utf-8。 |
### constructor
### constructor
constructor()
constructor()
...
@@ -509,6 +511,26 @@ TextEncoder的构造函数。
...
@@ -509,6 +511,26 @@ TextEncoder的构造函数。
let
textEncoder
=
new
util
.
TextEncoder
();
let
textEncoder
=
new
util
.
TextEncoder
();
```
```
### constructor<sup>9+</sup>
constructor(encoding?: string)
TextEncoder的构造函数。
**系统能力:**
SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ---- | ---- | ---- |
| encoding | string | 否 | 编码格式 |
**示例:**
```
js
let
textEncoder
=
new
util
.
TextEncoder
(
"
utf-8
"
);
```
### encodeInto<sup>9+</sup>
### encodeInto<sup>9+</sup>
encodeInto(input?: string): Uint8Array
encodeInto(input?: string): Uint8Array
...
@@ -566,7 +588,7 @@ let that = new util.TextEncoder()
...
@@ -566,7 +588,7 @@ let that = new util.TextEncoder()
let
buffer
=
new
ArrayBuffer
(
4
)
let
buffer
=
new
ArrayBuffer
(
4
)
let
dest
=
new
Uint8Array
(
buffer
)
let
dest
=
new
Uint8Array
(
buffer
)
let
result
=
new
Object
()
let
result
=
new
Object
()
result
=
that
.
encodeInto
(
'
abcd
'
,
dest
)
result
=
that
.
encodeInto
Uint8Array
(
'
abcd
'
,
dest
)
```
```
### encodeInto<sup>(deprecated)</sup>
### encodeInto<sup>(deprecated)</sup>
...
@@ -1464,7 +1486,7 @@ lru.afterRemoval(false,10,30,null);
...
@@ -1464,7 +1486,7 @@ lru.afterRemoval(false,10,30,null);
### contains<sup>9+</sup>
### contains<sup>9+</sup>
contains(key:
object
): boolean
contains(key:
K
): boolean
检查当前缓冲区是否包含指定的键。
检查当前缓冲区是否包含指定的键。
...
@@ -1474,7 +1496,7 @@ contains(key: object): boolean
...
@@ -1474,7 +1496,7 @@ contains(key: object): boolean
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------- |
| ------ | ------ | ---- | ---------------- |
| key |
object
| 是 | 表示要检查的键。 |
| key |
K
| 是 | 表示要检查的键。 |
**返回值:**
**返回值:**
...
@@ -1564,6 +1586,65 @@ pro.put(2,10);
...
@@ -1564,6 +1586,65 @@ pro.put(2,10);
let
result
=
pro
[
Symbol
.
iterator
]();
let
result
=
pro
[
Symbol
.
iterator
]();
```
```
## ScopeComparable<sup>8+</sup>
ScopeComparable类型的值需要实现compareTo方法,确保传入的数据具有可比性。
**系统能力:**
SystemCapability.Utils.Lang
### compareTo<sup>8+</sup>
compareTo(other: ScopeComparable): boolean;
比较两个值的大小,返回一个布尔值。
**系统能力:**
SystemCapability.Utils.Lang
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ---- | ---- | -------------- |
| other |
[
ScopeComparable
](
#scopecomparable8
)
| 是 | 表示要比较的值。 |
**返回值:**
| 类型 | 说明 |
| ---- | ------------------ |
| boolean | 调用compareTo的值大于等于传入的值返回true,否则返回false。|
**示例:**
构造新类,实现compareTo方法。后续示例代码中,均以此Temperature类为例。
```
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
();
}
}
```
## ScopeType<sup>8+</sup>
用于表示范围中的值的类型。
**系统能力:**
SystemCapability.Utils.Lang
| 类型 | 说明 |
| -------- | -------- |
| number | 表示值的类型为数字。 |
|
[
ScopeComparable
](
#scopecomparable8
)
| 表示值的类型为ScopeComparable。|
## ScopeHelper<sup>9+</sup>
## ScopeHelper<sup>9+</sup>
...
@@ -1644,7 +1725,7 @@ let range = new util.ScopeHelper(tempLower, tempUpper);
...
@@ -1644,7 +1725,7 @@ let range = new util.ScopeHelper(tempLower, tempUpper);
let
tempMiDF
=
new
Temperature
(
35
);
let
tempMiDF
=
new
Temperature
(
35
);
let
tempMidS
=
new
Temperature
(
39
);
let
tempMidS
=
new
Temperature
(
39
);
let
rangeFir
=
new
util
.
ScopeHelper
(
tempMiDF
,
tempMidS
);
let
rangeFir
=
new
util
.
ScopeHelper
(
tempMiDF
,
tempMidS
);
range
.
intersect
(
rangeFir
);
range
.
intersect
(
rangeFir
);
```
```
...
@@ -2121,46 +2202,8 @@ that.decode(array).then(val=>{
...
@@ -2121,46 +2202,8 @@ that.decode(array).then(val=>{
})
})
```
```
## ScopeType<sup>8+</sup>
用于表示范围中的值的类型。该类型的值,类型可以为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
();
}
}
```
## types<sup>8+</sup>
## types<sup>8+</sup>
### constructor<sup>8+</sup>
### constructor<sup>8+</sup>
constructor()
constructor()
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录