LZMA-JS 技术文档

1. 安装指南

LZMA-JS 可以通过 npm 或 bower 进行安装。

通过 npm 安装：

npm install lzma

通过 bower 安装：

bower install lzma

2. 项目的使用说明

首先，在您的 HTML 文件中引入 bootstrapping 代码：

<!-- 在浏览器中 -->
<script src="../src/lzma.js"></script>

然后，创建 LZMA 对象：

var my_lzma = new LZMA("../src/lzma_worker.js");

异步 (De)压缩

压缩

my_lzma.compress(string || byte_array, mode, on_finish(result, error), on_progress(percent));

解压缩

my_lzma.decompress(byte_array, on_finish(result, error), on_progress(percent));

同步 (De)压缩（不推荐，可能会导致客户端冻结）

压缩

var result = my_lzma.compress(string || byte_array, mode);

解压缩

var result = my_lzma.decompress(byte_array);

3. 项目 API 使用文档

LZMA.compress 方法

用于压缩字符串或字节数组。

参数：

• string || byte_array: 要压缩的字符串或字节数组。
• mode: 压缩模式，可选值为 1-9（1 是快速且压缩效果较好；9 是较慢但压缩效果更好）。
• on_finish(result, error): 压缩完成后调用的回调函数，其中 result 是压缩结果，error 是可能发生的错误。
• on_progress(percent): 压缩进度回调函数，percent 是当前压缩进度的百分比。

LZMA.decompress 方法

用于解压缩字节数组。

参数：

• byte_array: 要解压缩的字节数组。
• on_finish(result, error): 解压缩完成后调用的回调函数，其中 result 是解压缩结果，error 是可能发生的错误。
• on_progress(percent): 解压缩进度回调函数，percent 是当前解压缩进度的百分比。

4. 项目安装方式

LZMA-JS 支持 npm 和 bower 两种安装方式。

npm 安装

通过 npm 安装 LZMA-JS：

npm install lzma

bower 安装

通过 bower 安装 LZMA-JS：

bower install lzma