From c48cf12ddeeced47274cb910bdd4c3ac9cc014a7 Mon Sep 17 00:00:00 2001 From: wusongqing Date: Thu, 9 Jun 2022 14:41:01 +0800 Subject: [PATCH] updated docs Signed-off-by: wusongqing --- .../reference/apis/js-apis-zlib.md | 88 ++++++++----------- 1 file changed, 38 insertions(+), 50 deletions(-) diff --git a/en/application-dev/reference/apis/js-apis-zlib.md b/en/application-dev/reference/apis/js-apis-zlib.md index 2bf27848a2..761141b11f 100644 --- a/en/application-dev/reference/apis/js-apis-zlib.md +++ b/en/application-dev/reference/apis/js-apis-zlib.md @@ -1,7 +1,5 @@ # Zip Module (JavaScript SDK APIs) -## Constraints -None ## Modules to Import ```javascript @@ -9,7 +7,7 @@ import zlib from '@ohos.zlib'; ``` ## zlib.zipFile -zipFile(inFile:string, outFile:string, options: Options): Promise; +zipFile(inFile:string, outFile:string, options: Options): Promise\ Zips a file. This API uses a promise to return the result. **System capability**: SystemCapability.BundleManager.Zlib @@ -36,17 +34,14 @@ Zips a file. This API uses a promise to return the result. 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; +var options = { + level: zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION, + memLevel: zlib.MemLevel.MEM_LEVEL_DEFAULT, + 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"); - } + console.log("zipFile result: " + data); }).catch((err)=>{ console.log("catch((err)=>" + err); }); @@ -60,17 +55,14 @@ zlib.zipFile(inFile, outFile, options).then((data) => { 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"); - } +var options = { + level: zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION, + memLevel: zlib.MemLevel.MEM_LEVEL_DEFAULT, + strategy: zlib.CompressStrategy.COMPRESS_STRATEGY_DEFAULT_STRATEGY +}; + +zlib.zipFile(inFile , outFile, options).then((data) => { + console.log("zipFile result: " + data); }).catch((err)=>{ console.log("catch((err)=>" + err); }); @@ -78,7 +70,7 @@ zlib.zipFile(inFile , unzipDir, options).then((data) => { ## zlib.unzipFile -unzipFile(inFile:string, outFile:string, options: Options): Promise; +unzipFile(inFile:string, outFile:string, options: Options): Promise\ 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 | | ------- | ----------------------------------- | ---- | ----------------------------------- | -| 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. | | options | [Options](#options)| No | Optional parameters for the unzip operation. | @@ -106,30 +98,26 @@ 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; - +let options = { + level: zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION, + memLevel: zlib.MemLevel.MEM_LEVEL_DEFAULT, + 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"); - } + console.log("unzipFile result: " + data); }).catch((err)=>{ console.log("catch((err)=>" + err); }) ``` -## options +## Options | Name | Description | | --------------------------- | ------------------------------------------------------------ | -| level?: CompressLeve | See [zip.CompressLevel](##zipcompresslevel). | -| memLevel?: MemLevel | See [zip.MemLevel](#zipmemlevel) | -| strategy?: CompressStrategy | See [zip.CompressStrategy](#zipcompressstrategy) | +| level?: CompressLeve | See [zip.CompressLevel](#zipcompresslevel).| +| memLevel?: MemLevel | See [zip.MemLevel](#zipmemlevel). | +| strategy?: CompressStrategy | See [zip.CompressStrategy](#zipcompressstrategy).| ## zip.MemLevel @@ -143,24 +131,24 @@ zlib.unzipFile(inFile, outFile, options).then((data) => { | Name | Description | | --------------------------------------- | ----------------- | -| 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_COMPRESSION :9 | Compression level 9 that gives the best compression. | -| COMPRESS_LEVEL_DEFAULT_COMPRESSION : -1| Default compression level. | +| 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_COMPRESSION: 9 | Compression level 9 that gives the best compression. | +| COMPRESS_LEVEL_DEFAULT_COMPRESSION: -1| Default compression level. | ## Zip.CompressStrategy | Name | Description | | -------------------------------------- | ------------------------ | -| COMPRESS_STRATEGY_DEFAULT_STRATEGY : 0 | Default compression strategy. | -| COMPRESS_STRATEGY_FILTERED : 1 | Filtered compression strategy.| -| COMPRESS_STRATEGY_HUFFMAN_ONLY : 2 | Huffman coding compression strategy. | -| COMPRESS_STRATEGY_RLE : 3 | RLE compression strategy. | -| COMPRESS_STRATEGY_FIXED : 4 | Fixed compression strategy. | +| COMPRESS_STRATEGY_DEFAULT_STRATEGY: 0 | Default compression strategy. | +| COMPRESS_STRATEGY_FILTERED: 1 | Filtered compression strategy.| +| COMPRESS_STRATEGY_HUFFMAN_ONLY: 2 | Huffman coding compression strategy. | +| COMPRESS_STRATEGY_RLE: 3 | RLE compression strategy. | +| COMPRESS_STRATEGY_FIXED: 4 | Fixed compression strategy. | ## zip.ErrorCode | Name | Description | | -------------------- | ------------ | -| ERROR_CODE_OK: 0 | The API is successfully called.| -| ERROR_CODE_ERRNO:- 1 | Failed to call the API.| +| ERROR_CODE_OK: 0 | The API is successfully called.| +| ERROR_CODE_ERRNO: -1| Failed to call the API.| -- GitLab