Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
f2bb5b07
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看板
未验证
提交
f2bb5b07
编写于
3月 10, 2022
作者:
O
openharmony_ci
提交者:
Gitee
3月 10, 2022
浏览文件
操作
浏览文件
下载
差异文件
!1822 Add js-apis-zlib.md
Merge pull request !1822 from njupthan/update_master_0307
上级
9dfa7b54
3d6b244d
变更
1
显示空白变更内容
内联
并排
Showing
1 changed file
with
161 addition
and
0 deletion
+161
-0
zh-cn/application-dev/reference/apis/js-apis-zlib.md
zh-cn/application-dev/reference/apis/js-apis-zlib.md
+161
-0
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-zlib.md
0 → 100644
浏览文件 @
f2bb5b07
# Zip模块(JS端SDK接口)
## 使用限制
无。
## 导入模块
import zlib from '@ohos.zlib'
## zlib.zipFile
zipFile(inFile:string, outFile:string, options: Options): Promise
<void>
;
压缩接口(Promise形式)。
**系统能力:**
SystemCapability.BundleManager.Zlib
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ------- | ----------------------------------- | ---- | ------------------------------------------- |
| inFile | string | 是 | 指定压缩的文件夹路径或者文件路径 |
| outFile | string | 是 | 指定的压缩结果的文件路径(文件的扩展名zip) |
| options |
[
Options
](
#options对象可选参数说明
)
| 否 | 压缩的可选参数 |
**返回值:**
| 类型 | 说明 |
| -------------- | ---------------------------------------------------- |
| Promise
\<
void> | ERROR_CODE_OK:压缩成功 ERROR_CODE_ERRNO:压缩失败 |
**示例1:**
```
javascript
//【压缩文件 例子1】
import
zlib
from
'
@ohos.zlib
'
var
inFile
=
"
/xxx/filename.xxx
"
;
var
outFile
=
"
/xxx/xxx.zip
"
;
var
options
=
{};
options
.
level
=
zlib
.
CompressLevel
.
COMPRESS_LEVEL_DEFAULT_COMPRESSION
;
options
.
memLevel
=
zlib
.
MemLevel
.
MEM_LEVEL_DEFAULT
;
options
.
strategy
=
zlib
.
CompressStrategy
.
COMPRESS_STRATEGY_DEFAULT_STRATEGY
;
zlib
.
zipFile
(
inFile
,
outFile
,
options
).
then
((
data
)
=>
{
if
(
data
==
zlib
.
ErrorCode
.
ERROR_CODE_OK
)
{
console
.
log
(
"
zipFile OK
"
);
}
else
{
console
.
log
(
"
zipFile NG
"
);
}
}).
catch
((
err
)
=>
{
console
.
log
(
"
catch((err)=>
"
+
err
);
});
```
**示例2:**
```
// 【压缩文件夹 例子2】
import zlib from '@ohos.zlib'
var inFile = "/xxx/xxx";
var outFile = "/xxx/xxx.zip";
var options = {};
options.level = zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION;
options.memLevel = zlib.MemLevel.MEM_LEVEL_DEFAULT;
options.strategy = zlib.CompressStrategy.COMPRESS_STRATEGY_DEFAULT_STRATEGY;
zlib.zipFile(inFile , unzipDir, options).then((data) => {
if (data == zlib.ErrorCode.ERROR_CODE_OK) {
console.log("zipFile OK");
} else {
console.log("zipFile NG");
}
}).catch((err)=>{
console.log("catch((err)=>" + err);
});
```
## zlib.unzipFile
unzipFile(inFile:string, outFile:string, options: Options): Promise
<void>
;
解压文件,解压完成返回执行结果(Promise形式)。
**系统能力:**
SystemCapability.BundleManager.Zlib
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ------- | ----------------------------------- | ---- | ----------------------------------- |
| inFile | string | 是 | 指定解压的文件路径(文件扩展名zip) |
| outFile | string | 是 | 指定的解压文件路径 |
| options |
[
Options
](
#options对象可选参数说明
)
| 否 | 解压的可选参数 |
**返回值:**
| 类型 | 说明 |
| -------------- | ------------------------------------------------------------ |
| Promise
\<
void> | ERROR_CODE_OK:解压成功 ERROR_CODE_ERRNO:解压失败返回执行结果。 |
**示例:**
```
javascript
// 【解压例子1】
import
zlib
from
'
@ohos.zlib
'
var
inFile
=
"
/xx/xxx.zip
"
;
var
outFile
=
"
/xxx
"
;
var
options
=
{};
options
.
level
=
zlib
.
CompressLevel
.
COMPRESS_LEVEL_DEFAULT_COMPRESSION
;
options
.
memLevel
=
zlib
.
MemLevel
.
MEM_LEVEL_DEFAULT
;
options
.
strategy
=
zlib
.
CompressStrategy
.
COMPRESS_STRATEGY_DEFAULT_STRATEGY
;
zlib
.
unzipFile
(
inFile
,
outFile
,
options
).
then
((
data
)
=>
{
if
(
data
==
zlib
.
ErrorCode
.
ERROR_CODE_OK
)
{
console
.
log
(
"
unzipFile OK
"
);
}
else
{
console
.
log
(
"
unzipFile NG
"
);
}
}).
catch
((
err
)
=>
{
console
.
log
(
"
catch((err)=>
"
+
err
);
})
```
## Options对象可选参数说明
| 参数 | |
| --------------------------- | ------------------------------------------------------------ |
| level?: CompressLeve |
[
参考zip.CompressLevel枚举定义
](
#zip.CompressLevel压缩等级可选参数说明
)
|
| memLevel?: MemLevel |
[
参考zip.MemLevel枚举定义
](
#zip.MemLevel可选参数说明
)
|
| strategy?: CompressStrategy |
[
参考zip.CompressStrategy枚举定义
](
#zip.CompressStrategy压缩策略可选参数说明
)
|
## zip.MemLevel可选参数说明
| MEM_LEVEL_MIN | zip 接口在压缩过程中最小使用内存 |
| ----------------- | -------------------------------- |
| MEM_LEVEL_MAX | zip 接口在压缩过程中最大使用内存 |
| MEM_LEVEL_DEFAULT | zip 接口在压缩过程中默认使用内存 |
## zip.CompressLevel压缩等级可选参数说明
| 参数 | 描述 |
| --------------------------------------- | ----------------- |
| COMPRESS_LEVEL_NO_COMPRESSION : 0 | 压缩率为0压缩等级 |
| COMPRESS_LEVEL_BEST_SPEED : 1 | 最佳速度压缩等级 |
| COMPRESS_LEVEL_BEST_COMPRESSION :9 | 最佳压缩等级 |
| COMPRESS_LEVEL_DEFAULT_COMPRESSION :-1 | 默认压缩等级 |
## zip.CompressStrategy压缩策略可选参数说明
| 参数 | 描述 |
| -------------------------------------- | ------------------------ |
| COMPRESS_STRATEGY_DEFAULT_STRATEGY : 0 | 常规数据策略 |
| COMPRESS_STRATEGY_FILTERED : 1 | 过滤器产生的数据压缩策略 |
| COMPRESS_STRATEGY_HUFFMAN_ONLY : 2 | 霍夫曼编码格式压缩策略 |
| OMPRESS_STRATEGY_RLE : 3 | 游标编码压缩策略 |
| COMPRESS_STRATEGY_FIXED : 4 | 固定的压缩策略 |
## zip.ErrorCode接口返回值参数说明
| 参数 | 描述 |
| -------------------- | ------------ |
| ERROR_CODE_OK: 0 | 函数调用成功 |
| ERROR_CODE_ERRNO:- 1 | 函数调用失败 |
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录