提交 c48cf12d 编写于 作者: W wusongqing

updated docs

Signed-off-by: Nwusongqing <wusongqing@huawei.com>
上级 1632d97f
# Zip Module (JavaScript SDK APIs) # Zip Module (JavaScript SDK APIs)
## Constraints
None
## Modules to Import ## Modules to Import
```javascript ```javascript
...@@ -9,7 +7,7 @@ import zlib from '@ohos.zlib'; ...@@ -9,7 +7,7 @@ import zlib from '@ohos.zlib';
``` ```
## zlib.zipFile ## zlib.zipFile
zipFile(inFile:string, outFile:string, options: Options): Promise<void>; zipFile(inFile:string, outFile:string, options: Options): Promise\<void>
Zips a file. This API uses a promise to return the result. Zips a file. This API uses a promise to return the result.
**System capability**: SystemCapability.BundleManager.Zlib **System capability**: SystemCapability.BundleManager.Zlib
...@@ -36,17 +34,14 @@ Zips a file. This API uses a promise to return the result. ...@@ -36,17 +34,14 @@ Zips a file. This API uses a promise to return the result.
import zlib from '@ohos.zlib' import zlib from '@ohos.zlib'
var inFile = "/xxx/filename.xxx"; var inFile = "/xxx/filename.xxx";
var outFile = "/xxx/xxx.zip"; var outFile = "/xxx/xxx.zip";
var options = {}; var options = {
options.level = zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION; level: zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION,
options.memLevel = zlib.MemLevel.MEM_LEVEL_DEFAULT; memLevel: zlib.MemLevel.MEM_LEVEL_DEFAULT,
options.strategy = zlib.CompressStrategy.COMPRESS_STRATEGY_DEFAULT_STRATEGY; strategy: zlib.CompressStrategy.COMPRESS_STRATEGY_DEFAULT_STRATEGY
};
zlib.zipFile(inFile, outFile, options).then((data) => { zlib.zipFile(inFile, outFile, options).then((data) => {
if (data == zlib.ErrorCode.ERROR_CODE_OK) { console.log("zipFile result: " + data);
console.log("zipFile OK");
} else {
console.log("zipFile NG");
}
}).catch((err)=>{ }).catch((err)=>{
console.log("catch((err)=>" + err); console.log("catch((err)=>" + err);
}); });
...@@ -60,17 +55,14 @@ zlib.zipFile(inFile, outFile, options).then((data) => { ...@@ -60,17 +55,14 @@ zlib.zipFile(inFile, outFile, options).then((data) => {
import zlib from '@ohos.zlib' import zlib from '@ohos.zlib'
var inFile = "/xxx/xxx"; var inFile = "/xxx/xxx";
var outFile = "/xxx/xxx.zip"; var outFile = "/xxx/xxx.zip";
var options = {}; var options = {
options.level = zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION; level: zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION,
options.memLevel = zlib.MemLevel.MEM_LEVEL_DEFAULT; memLevel: zlib.MemLevel.MEM_LEVEL_DEFAULT,
options.strategy = zlib.CompressStrategy.COMPRESS_STRATEGY_DEFAULT_STRATEGY; strategy: zlib.CompressStrategy.COMPRESS_STRATEGY_DEFAULT_STRATEGY
};
zlib.zipFile(inFile , unzipDir, options).then((data) => {
if (data == zlib.ErrorCode.ERROR_CODE_OK) { zlib.zipFile(inFile , outFile, options).then((data) => {
console.log("zipFile OK"); console.log("zipFile result: " + data);
} else {
console.log("zipFile NG");
}
}).catch((err)=>{ }).catch((err)=>{
console.log("catch((err)=>" + err); console.log("catch((err)=>" + err);
}); });
...@@ -78,7 +70,7 @@ zlib.zipFile(inFile , unzipDir, options).then((data) => { ...@@ -78,7 +70,7 @@ zlib.zipFile(inFile , unzipDir, options).then((data) => {
## zlib.unzipFile ## zlib.unzipFile
unzipFile(inFile:string, outFile:string, options: Options): Promise<void>; unzipFile(inFile:string, outFile:string, options: Options): Promise\<void>
Unzips a file. This API uses a promise to return the result. Unzips a file. This API uses a promise to return the result.
...@@ -88,7 +80,7 @@ Unzips a file. This API uses a promise to return the result. ...@@ -88,7 +80,7 @@ Unzips a file. This API uses a promise to return the result.
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ------- | ----------------------------------- | ---- | ----------------------------------- | | ------- | ----------------------------------- | ---- | ----------------------------------- |
| inFile | string | Yes | Path of the file to unzip. The file name extension is .zip.| | inFile | string | Yes | Path of the .zip file to unzip.|
| outFile | string | Yes | Path of the unzipped file. | | outFile | string | Yes | Path of the unzipped file. |
| options | [Options](#options)| No | Optional parameters for the unzip operation. | | options | [Options](#options)| No | Optional parameters for the unzip operation. |
...@@ -106,30 +98,26 @@ import zlib from '@ohos.zlib' ...@@ -106,30 +98,26 @@ import zlib from '@ohos.zlib'
var inFile = "/xx/xxx.zip"; var inFile = "/xx/xxx.zip";
var outFile = "/xxx"; var outFile = "/xxx";
var options = {}; let options = {
options.level = zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION; level: zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION,
options.memLevel = zlib.MemLevel.MEM_LEVEL_DEFAULT; memLevel: zlib.MemLevel.MEM_LEVEL_DEFAULT,
options.strategy = zlib.CompressStrategy.COMPRESS_STRATEGY_DEFAULT_STRATEGY; strategy: zlib.CompressStrategy.COMPRESS_STRATEGY_DEFAULT_STRATEGY
};
zlib.unzipFile(inFile, outFile, options).then((data) => { zlib.unzipFile(inFile, outFile, options).then((data) => {
if (data == zlib.ErrorCode.ERROR_CODE_OK) { console.log("unzipFile result: " + data);
console.log("unzipFile OK");
} else {
console.log("unzipFile NG");
}
}).catch((err)=>{ }).catch((err)=>{
console.log("catch((err)=>" + err); console.log("catch((err)=>" + err);
}) })
``` ```
## options ## Options
| Name | Description | | Name | Description |
| --------------------------- | ------------------------------------------------------------ | | --------------------------- | ------------------------------------------------------------ |
| level?: CompressLeve | See [zip.CompressLevel](##zipcompresslevel). | | level?: CompressLeve | See [zip.CompressLevel](#zipcompresslevel).|
| memLevel?: MemLevel | See [zip.MemLevel](#zipmemlevel) | | memLevel?: MemLevel | See [zip.MemLevel](#zipmemlevel). |
| strategy?: CompressStrategy | See [zip.CompressStrategy](#zipcompressstrategy) | | strategy?: CompressStrategy | See [zip.CompressStrategy](#zipcompressstrategy).|
## zip.MemLevel ## zip.MemLevel
...@@ -143,24 +131,24 @@ zlib.unzipFile(inFile, outFile, options).then((data) => { ...@@ -143,24 +131,24 @@ zlib.unzipFile(inFile, outFile, options).then((data) => {
| Name | Description | | Name | Description |
| --------------------------------------- | ----------------- | | --------------------------------------- | ----------------- |
| COMPRESS_LEVEL_NO_COMPRESSION : 0 | Compress level 0 that indicates uncompressed.| | COMPRESS_LEVEL_NO_COMPRESSION: 0 | Compress level 0 that indicates uncompressed.|
| COMPRESS_LEVEL_BEST_SPEED : 1 | Compression level 1 that gives the best speed. | | COMPRESS_LEVEL_BEST_SPEED: 1 | Compression level 1 that gives the best speed. |
| COMPRESS_LEVEL_BEST_COMPRESSION :9 | Compression level 9 that gives the best compression. | | COMPRESS_LEVEL_BEST_COMPRESSION: 9 | Compression level 9 that gives the best compression. |
| COMPRESS_LEVEL_DEFAULT_COMPRESSION : -1| Default compression level. | | COMPRESS_LEVEL_DEFAULT_COMPRESSION: -1| Default compression level. |
## Zip.CompressStrategy ## Zip.CompressStrategy
| Name | Description | | Name | Description |
| -------------------------------------- | ------------------------ | | -------------------------------------- | ------------------------ |
| COMPRESS_STRATEGY_DEFAULT_STRATEGY : 0 | Default compression strategy. | | COMPRESS_STRATEGY_DEFAULT_STRATEGY: 0 | Default compression strategy. |
| COMPRESS_STRATEGY_FILTERED : 1 | Filtered compression strategy.| | COMPRESS_STRATEGY_FILTERED: 1 | Filtered compression strategy.|
| COMPRESS_STRATEGY_HUFFMAN_ONLY : 2 | Huffman coding compression strategy. | | COMPRESS_STRATEGY_HUFFMAN_ONLY: 2 | Huffman coding compression strategy. |
| COMPRESS_STRATEGY_RLE : 3 | RLE compression strategy. | | COMPRESS_STRATEGY_RLE: 3 | RLE compression strategy. |
| COMPRESS_STRATEGY_FIXED : 4 | Fixed compression strategy. | | COMPRESS_STRATEGY_FIXED: 4 | Fixed compression strategy. |
## zip.ErrorCode ## zip.ErrorCode
| Name | Description | | Name | Description |
| -------------------- | ------------ | | -------------------- | ------------ |
| ERROR_CODE_OK: 0 | The API is successfully called.| | ERROR_CODE_OK: 0 | The API is successfully called.|
| ERROR_CODE_ERRNO:- 1 | Failed to call the API.| | ERROR_CODE_ERRNO: -1| Failed to call the API.|
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册