Module 基础模块

模块 zip

zip 格式文件压缩解压模块

使用方法:

1
var zip = require('zip');

静态函数

isZipFile

判断文件是否是zip格式

1
static Boolean zip.isZipFile(String filename) async;

调用参数:

  • filename: String, 文件名

返回结果:

  • Boolean, 返回true代表文件是zip文件

open

打开一个zip文件

1 2 3
static ZipFile zip.open(String path, String mod = "r", Integer compress_type = ZIP_DEFLATED) async;

调用参数:

  • path: String, 文件路径
  • mod: String, 打开文件模式, "r"代表读取, "w"代表创建, "a"代表在zip文件后追加
  • compress_type: Integer, 压缩类型, ZIP_STORED 代表不压缩, 仅存储。 默认使用ZIP_DEFLATED 代表使用zlib库进行压缩。

返回结果:


打开一个zip文件

1 2 3
static ZipFile zip.open(Buffer data, String mod = "r", Integer compress_type = ZIP_DEFLATED) async;

调用参数:

  • data: Buffer, zip文件数据
  • mod: String, 打开文件模式, "r"代表读取, "w"代表创建, "a"代表在zip文件后追加
  • compress_type: Integer, 压缩类型, ZIP_STORED 代表不压缩, 仅存储。 默认使用ZIP_DEFLATED 代表使用zlib库进行压缩。

返回结果:


打开一个zip文件

1 2 3
static ZipFile zip.open(SeekableStream strm, String mod = "r", Integer compress_type = ZIP_DEFLATED) async;

调用参数:

  • strm: SeekableStream, zip文件流
  • mod: String, 打开文件模式, "r"代表读取, "w"代表创建, "a"代表在zip文件后追加
  • compress_type: Integer, 压缩类型, ZIP_STORED 代表不压缩, 仅存储。 默认使用ZIP_DEFLATED 代表使用zlib库进行压缩。

返回结果:

常量

ZIP_STORED

压缩类型常量, 不压缩, 仅存储

1
const zip.ZIP_STORED = 0;

ZIP_DEFLATED

压缩类型常量, 需要依赖zlib库进行压缩

1
const zip.ZIP_DEFLATED = 1;