Compress 模块

压缩和解压缩文件的工具模块,支持ZIP、TGZ和Brotli格式。

功能特性

✅ ZIP文件操作（列表、解压、添加、删除）

✅ TGZ文件解压

✅ Brotli压缩和解压缩

✅ 支持文件路径替换

✅ 高效的压缩算法

基本使用

ZIP操作

列出ZIP文件内容

解压ZIP文件

添加文件到ZIP

从ZIP删除文件

TGZ操作

解压TGZ文件

Brotli压缩

压缩数据

解压数据

API参考

compress.zip

ZIP文件操作对象。

zip.list(zipFile)

列出ZIP文件中的所有文件。

参数：

zipFile (string): ZIP文件路径

返回值： JSON字符串，包含文件列表信息

zip.extract(zipFile, destFolder, filesList)

解压ZIP文件。

参数：

zipFile (string): ZIP文件路径

destFolder (string): 目标目录路径

filesList (string): 要解压的文件列表，用逗号分隔；空字符串表示解压所有文件

返回值： boolean - 成功返回true，失败返回false

zip.add(zipFile, filesList, oldFrom, newFrom)

向ZIP文件添加文件。

参数：

zipFile (string): ZIP文件路径

filesList (string): 要添加的文件列表，用逗号分隔

oldFrom (string, 可选): 原路径前缀，用于路径替换

newFrom (string, 可选): 新路径前缀，用于路径替换

返回值： boolean - 成功返回true，失败返回false

zip.del(zipFile, filesList)

从ZIP文件删除文件。

参数：

zipFile (string): ZIP文件路径

filesList (string): 要删除的文件列表，用逗号分隔

返回值： boolean - 成功返回true，失败返回false

compress.tgz

TGZ文件操作对象。

tgz.extract(tgzFile, destFolder)

解压TGZ文件。

参数：

tgzFile (string): TGZ文件路径

destFolder (string): 目标目录路径

返回值： boolean - 成功返回true，失败返回false

compress.brotli

Brotli压缩操作对象。

brotli.compress(data)

使用Brotli算法压缩数据。

参数：

data (string|Buffer): 要压缩的数据

返回值： Buffer - 压缩后的数据

brotli.decompress(data)

解压Brotli压缩的数据。

参数：

data (Buffer): 压缩的数据

返回值： string|Buffer - 解压后的数据

注意事项

文件路径：确保提供的文件路径存在且有相应的读写权限。

ZIP操作：添加和删除操作会直接修改原ZIP文件。

文件列表格式：多个文件使用逗号分隔，不要有空格。

路径替换：使用oldFrom和newFrom参数可以在添加文件时修改文件在ZIP中的路径。

返回值检查：操作失败时返回false，建议检查返回值以处理错误。

实际应用场景

批量处理ZIP文件

压缩和解压缩配置数据

性能提示

Brotli压缩比率高，适合文本数据压缩

ZIP操作支持大文件处理

TGZ解压适合Unix/Linux环境的归档文件

对于频繁的ZIP修改操作，建议批量处理以提高效率

compress

Compress 模块#

功能特性#

基本使用#

ZIP操作#

列出ZIP文件内容#

解压ZIP文件#

添加文件到ZIP#

从ZIP删除文件#

TGZ操作#

解压TGZ文件#

Brotli压缩#

压缩数据#

解压数据#

API参考#

compress.zip#

zip.list(zipFile)#

zip.extract(zipFile, destFolder, filesList)#

zip.add(zipFile, filesList, oldFrom, newFrom)#

zip.del(zipFile, filesList)#

compress.tgz#

tgz.extract(tgzFile, destFolder)#

compress.brotli#

brotli.compress(data)#

brotli.decompress(data)#

注意事项#

实际应用场景#

批量处理ZIP文件#

压缩和解压缩配置数据#

性能提示#

Compress 模块

功能特性

基本使用

ZIP操作

列出ZIP文件内容

解压ZIP文件

添加文件到ZIP

从ZIP删除文件

TGZ操作

解压TGZ文件

Brotli压缩

压缩数据

解压数据

API参考

compress.zip

zip.list(zipFile)

zip.extract(zipFile, destFolder, filesList)

zip.add(zipFile, filesList, oldFrom, newFrom)

zip.del(zipFile, filesList)

compress.tgz

tgz.extract(tgzFile, destFolder)

compress.brotli

brotli.compress(data)

brotli.decompress(data)

注意事项

实际应用场景

批量处理ZIP文件

压缩和解压缩配置数据

性能提示