From 25832cbbed8f4a4f8656b11989303da036b02126 Mon Sep 17 00:00:00 2001 From: junyi233 Date: Sat, 25 Jun 2022 17:35:07 +0800 Subject: [PATCH] =?UTF-8?q?md=E6=96=87=E6=A1=A3=E6=89=AB=E6=8F=8F=E7=BC=BA?= =?UTF-8?q?=E9=99=B7=E4=BF=AE=E6=94=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: junyi233 --- .../reference/apis/js-apis-Bundle.md | 26 ++-- .../reference/apis/js-apis-zlib.md | 143 +++++++++--------- 2 files changed, 80 insertions(+), 89 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-Bundle.md b/zh-cn/application-dev/reference/apis/js-apis-Bundle.md index 28fae15bae..3a7382c8bb 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-Bundle.md +++ b/zh-cn/application-dev/reference/apis/js-apis-Bundle.md @@ -29,7 +29,7 @@ getApplicationInfo(bundleName: string, bundleFlags: number, userId?: number): Pr **需要权限：** -ohos.permission.GET_BUNDLE_INFO_PRIVILEGED，ohos.permission.GET_BUNDLE_INFO +ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO **系统能力：** @@ -264,7 +264,7 @@ getBundleInfo(bundleName: string, bundleFlags: number, options?: BundleOptions): **需要权限：** -ohos.permission.GET_BUNDLE_INFO_PRIVILEGED，ohos.permission.GET_BUNDLE_INFO +ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO **系统能力：** @@ -568,7 +568,7 @@ getAbilityInfo(bundleName: string, abilityName: string): Promise\ **需要权限：** -ohos.permission.GET_BUNDLE_INFO_PRIVILEGED，ohos.permission.GET_BUNDLE_INFO +ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO **系统能力：** @@ -644,7 +644,7 @@ getAbilityLabel(bundleName: string, abilityName: string): Promise\ **需要权限：** -ohos.permission.GET_BUNDLE_INFO_PRIVILEGED，ohos.permission.GET_BUNDLE_INFO +ohos.permission.GET_BUNDLE_INFO_PRIVILEGED 或 ohos.permission.GET_BUNDLE_INFO **系统能力：** @@ -718,10 +718,6 @@ isAbilityEnabled(info: AbilityInfo): Promise\ 以异步方法根据给定的AbilityInfo查询ability是否已经启用，使用Promise形式返回结果。 -**需要权限：** - -无 - **系统能力：** SystemCapability.BundleManager.BundleFramework @@ -796,10 +792,6 @@ isApplicationEnabled(bundleName: string): Promise\ 以异步方法根据给定的bundleName查询指定应用程序是否已经启用，使用Promise形式返回结果。 -**需要权限：** - -无 - **系统能力：** SystemCapability.BundleManager.BundleFramework @@ -870,7 +862,7 @@ queryAbilityByWant(want: Want, bundleFlags: number, userId?: number): Promise ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + ## 使用限制 + 无。 ## 导入模块 @@ -9,18 +13,19 @@ import zlib from '@ohos.zlib'; ``` ## zlib.zipFile -zipFile(inFile:string, outFile:string, options: Options): Promise\ +zipFile(inFile:string, outFile:string, options: Options): Promise<void> + 压缩接口（Promise形式）。 **系统能力：** SystemCapability.BundleManager.Zlib **参数：** -| 名称 | 类型 | 必填 | 描述 | -| ------- | ----------------------------------- | ---- | ------------------------------------------- | -| inFile | string | 是 | 指定压缩的文件夹路径或者文件路径 | -| outFile | string | 是 | 指定的压缩结果的文件路径（文件的扩展名zip） | -| options | [Options](#options对象可选参数说明) | 否 | 压缩的可选参数 | +| 参数名 | 类型 | 必填 | 描述 | +| ------- | ------------------- | ---- | ------------------------------------------- | +| inFile | string | 是 | 指定压缩的文件夹路径或者文件路径 | +| outFile | string | 是 | 指定的压缩结果的文件路径（文件的扩展名zip） | +| options | [Options](#options) | 否 | 压缩的可选参数 | **返回值：** @@ -36,17 +41,14 @@ zipFile(inFile:string, outFile:string, options: Options): Promise\ 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 +62,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 +77,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<void> 解压文件，解压完成返回执行结果（Promise形式）。 @@ -86,11 +85,11 @@ unzipFile(inFile:string, outFile:string, options: Options): Promise\ **参数：** -| 名称 | 类型 | 必填 | 描述 | -| ------- | ----------------------------------- | ---- | ----------------------------------- | -| inFile | string | 是 | 指定解压的文件路径（文件扩展名zip） | -| outFile | string | 是 | 指定的解压文件路径 | -| options | [Options](#options对象可选参数说明) | 否 | 解压的可选参数 | +| 参数名 | 类型 | 必填 | 描述 | +| ------- | ------------------- | ---- | ----------------------------------- | +| inFile | string | 是 | 指定解压的文件路径（文件扩展名zip） | +| outFile | string | 是 | 指定的解压文件路径 | +| options | [Options](#options) | 否 | 解压的可选参数 | **返回值：** @@ -106,61 +105,57 @@ 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 -| 参数 | 说明 | -| --------------------------- | ------------------------------------------------------------ | -| level?: CompressLeve | [参考zip.CompressLevel枚举定义](#zip.CompressLevel压缩等级可选参数说明) | -| memLevel?: MemLevel | [参考zip.MemLevel枚举定义](#zip.MemLevel可选参数说明) | -| strategy?: CompressStrategy | [参考zip.CompressStrategy枚举定义](#zip.CompressStrategy压缩策略可选参数说明) | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------- | ---- | --------------------------------------------------------- | +| level | CompressLeve | 否 | [参考zip.CompressLevel枚举定义](#zip.CompressLevel) | +| memLevel | MemLevel | 否 | [参考zip.MemLevel枚举定义](#zip.MemLevel) | +| userId | CompressStrategy | 否 | [参考zip.CompressStrategy枚举定义](#zip.CompressStrategy) | -## zip.MemLevel可选参数说明 +## zip.MemLevel -| 参数 | 说明 | -| ----------------- | -------------------------------- | -| MEM_LEVEL_MIN | zip 接口在压缩过程中最小使用内存 | -| MEM_LEVEL_MAX | zip 接口在压缩过程中最大使用内存 | -| MEM_LEVEL_DEFAULT | zip 接口在压缩过程中默认使用内存 | +| 名称 | 值 | 说明 | +| ----------------- | ---- | -------------------------------- | +| MEM_LEVEL_MIN | 1 | zip 接口在压缩过程中最小使用内存 | +| MEM_LEVEL_MIN | 9 | zip 接口在压缩过程中最大使用内存 | +| MEM_LEVEL_DEFAULT | 8 | zip 接口在压缩过程中默认使用内存 | -## zip.CompressLevel压缩等级可选参数说明 +## zip.CompressLevel -| 参数 | 描述 | -| --------------------------------------- | ----------------- | -| COMPRESS_LEVEL_NO_COMPRESSION : 0 | 压缩率为0压缩等级 | -| COMPRESS_LEVEL_BEST_SPEED : 1 | 最佳速度压缩等级 | -| COMPRESS_LEVEL_BEST_COMPRESSION :9 | 最佳压缩等级 | -| COMPRESS_LEVEL_DEFAULT_COMPRESSION ：-1 | 默认压缩等级 | +| 名称 | 值 | 说明 | +| ---------------------------------- | ---- | ----------------- | +| COMPRESS_LEVEL_NO_COMPRESSION | 0 | 压缩率为0压缩等级 | +| COMPRESS_LEVEL_BEST_SPEED | 1 | 最佳速度压缩等级 | +| COMPRESS_LEVEL_BEST_COMPRESSION | 9 | 最佳压缩等级 | +| COMPRESS_LEVEL_DEFAULT_COMPRESSION | -1 | 默认压缩等级 | -## zip.CompressStrategy压缩策略可选参数说明 +## zip.CompressStrategy -| 参数 | 描述 | -| -------------------------------------- | ------------------------ | -| COMPRESS_STRATEGY_DEFAULT_STRATEGY : 0 | 常规数据策略 | -| COMPRESS_STRATEGY_FILTERED : 1 | 过滤器产生的数据压缩策略 | -| COMPRESS_STRATEGY_HUFFMAN_ONLY : 2 | 霍夫曼编码格式压缩策略 | -| COMPRESS_STRATEGY_RLE : 3 | 游标编码压缩策略 | -| COMPRESS_STRATEGY_FIXED : 4 | 固定的压缩策略 | +| 名称 | 值 | 说明 | +| ---------------------------------- | ---- | ------------------------ | +| COMPRESS_STRATEGY_DEFAULT_STRATEGY | 0 | 常规数据策略 | +| COMPRESS_STRATEGY_FILTERED | 1 | 过滤器产生的数据压缩策略 | +| COMPRESS_STRATEGY_HUFFMAN_ONLY | 2 | 霍夫曼编码格式压缩策略 | +| COMPRESS_STRATEGY_RLE | 3 | 游标编码压缩策略 | +| COMPRESS_STRATEGY_FIXED | 4 | 固定的压缩策略 | -## zip.ErrorCode接口返回值参数说明 +## zip.ErrorCode -| 参数 | 描述 | -| -------------------- | ------------ | -| ERROR_CODE_OK: 0 | 函数调用成功 | -| ERROR_CODE_ERRNO:- 1 | 函数调用失败 | +| 名称 | 值 | 说明 | +| ---------------- | ---- | ------------ | +| ERROR_CODE_OK | 0 | 函数调用成功 | +| ERROR_CODE_ERRNO | -1 | 函数调用失败 | -- GitLab