更新记录

0.0.2（2025-05-02）

• feat 增加decompressGzipSync同步方法

0.0.1（2025-05-01）

• init

平台兼容性

lime-gzip GZip 数据流解压

安装

插件市场导入，安卓，ios需要自定义基座，鸿蒙next和web只能源码使用

引入

// uniapp不需要强制类型 所以不需要引入 UnGZipOptions
import { decompressGzip, decompressGzipSync, type UnGZipOptions } from '@/uni_modules/lime-gzip'

API 详解

decompressGzip 解压方法

function decompressGzip(options: UnGZipOptions): void
// 同步方法
function decompressGzipSync(options: UnGZipOptions): UnGZipSuccess|null

参数说明：

返回结果（UnGZipSuccess）：

interface UnGZipSuccess {
  data?: Uint8Array | string    // 根据asText参数决定类型
  outputPath?: string
  originalSize: number          // 解压后数据大小
  compressedSize: number        // 压缩前数据大小
}

使用示例

const compressedData = new Uint8Array([...]); // GZIP压缩数据

// 返回 Uint8Array
decompressGzip({
  input: compressedData,
  success: (res) => {
    console.log('Decompressed data:', res.data);
    console.log('Original size:', res.originalSize);
    console.log('Compressed size:', res.compressedSize);
  }
} as UnGZipOptions); // uniapp不需要强制类型 所以不需要 as UnGZipOptions

// 返回字符串
decompressGzip({
  input: compressedData,
  asText: true,
  success: (res) => {
    console.log('Decompressed text:', res.data);
  }
} as UnGZipOptions); // uniapp不需要强制类型 所以不需要 as UnGZipOptions

compressToGzip 压缩方法

该方法未实现

function compressToGzip(options: GZipOptions): void

参数说明：

返回结果（GZipSuccess）：

interface GZipSuccess {
  data?: Uint8Array | string    // 非文件模式返回压缩数据
  outputPath?: string           // 文件模式返回存储路径
  originalSize: number          // 原始数据字节数
  compressedSize: number        // 压缩后字节数
}

错误处理

错误码规范

type GZipErrorCode = 
  9010001 |   // 输入数据无效
  9010002 |   // 文件读取失败 
  9010003 |   // 文件写入失败
  9010004 |   // 解压过程失败
  9010005 |   // 非法的GZIP格式
  9010006 |   // CRC校验失败
  9099999     // 未知错误

错误对象结构

interface GZipFail {
  errCode: GZipErrorCode
  errMsg: string
  // 继承自IUniError的其他标准字段...
}