云控系统开发文档

zip - 压缩与解压

zip - 压缩与解压

Zip模块用于处理文件的压缩和解压，并支持加密压缩。

参见

zip4jopen in new window

目录

接口

类型别名

函数

类型别名

ZipFileAttribute

Ƭ ZipFileAttribute: "all" | "archive" | "dateTime" | "hidden" | "system" | "readOnly"

  • alls 所有属性
  • archive 压缩包属性
  • dateTime 时间
  • hidden 是否隐藏
  • readOnly 是否只读
  • system 是否为系统文件

参见

ignoreAttributes

函数

open

▸ open(file): ZipFile

打开一个zip文件，返回ZipFile对象，可对该对象进行进一步的zip操作。

参数

名称 类型 描述
file string 压缩包文件路径

返回值

ZipFile

unzip

▸ unzip(zipFile, dest, options?): Promise<void>

解压zip文件。如果文件夹dest不存在则创建该文件夹并将内容解压到里面；如果dest已经存在，则在dest下面创建一个和zipFile文件同名的文件夹，并将内容解压到里面。

示例

"nodejs";
const { unzip, zipDir } = require('zip');

async function main() {
    // create a zip file with password
    const zipFilePath = './dest.zip';
    await zipDir('./dir', zipFilePath, { password: 'CloudControl Pro' });
    // unzip the zip file
    await unzip(zipFilePath, './dest', { password: 'CloudControl Pro' });
}
main();

参数

名称 类型 描述
zipFile string 需解压的压缩包文件路径
dest string 解压后的文件夹目录
options? UnzipOptions 解压选项，可选

返回值

Promise<void>

zipDir

▸ zipDir(dir, dest, options?): Promise<ZipFile>

压缩文件夹下所有文件/文件夹，生成到目标路径dest。

示例

const { zipDir } = require('zip');
zipDir('./dir', './dest.zip')
 .then(zipFile => console.log(zipFile));

参数

名称 类型 描述
dir string 需要压缩的文件夹路径，如果文件夹下有子文件夹均会一并压缩
dest string 压缩后的压缩包存放路径
options? ZipOptions 可选参数

返回值

Promise<ZipFile>

zipFile

▸ zipFile(file, dest, options?): Promise<ZipFile>

压缩单文件file到路径dest。

示例

const { zipFile } = require('zip');
zipFile('./file.txt', './dest.zip')
 .then(zipFile => console.log(zipFile));

参数

名称 类型 描述
file string 需要压缩的单文件路径。
dest string 压缩后的压缩包存放路径
options? ZipOptions 选项

返回值

Promise<ZipFile>

zipFiles

▸ zipFiles(fileList, dest, options?): Promise<ZipFile>

压缩多个文件fileList到路径dest。fileList中不能包含文件夹。

示例

const { zipFiles } = require('zip');
zipFiles(['./file1.txt', './file2.txt'], './dest.zip')
 .then(zipFile => console.log(zipFile));

参数

名称 类型 描述
fileList string[] 需压缩的多个文件路径的数组
dest string 压缩目标路径
options? ZipOptions 选项

返回值

Promise<ZipFile>