接口: ZipOptions

更新: 2025/7/20 字数: 0 字 时长: 0 分钟

zip.ZipOptions

压缩选项。

示例

const { zipDir } = require('zip');
zipDir('./dir', './dest.zip', {
   compressionLevel: 9,
   password: '123456',
   includeRootFolder: false,
});

参见

• zipDir
• zipFiles
• zipFile
• addFolder
• addFile
• addFiles

目录

属性

• aesKeyStrength
• compressionLevel
• compressionMethod
• defaultFolderPath
• encryptionMethod
• fileNameInZip
• includeRootFolder
• password
• readHiddenFiles
• rootFolderInZip

属性

aesKeyStrength

• Optional aesKeyStrength: "AES_STRENGTH_128" | "AES_STRENGTH_192" | "AES_STRENGTH_256"

AES加密强度，包括 AES_STRENGTH_128，AES_STRENGTH_192，AES_STRENGTH_256

---

compressionLevel

• Optional compressionLevel: number

压缩级别，0~9，0为不压缩，9为最好压缩（速度较慢）。默认为5（正常压缩）。

---

compressionMethod

• Optional compressionMethod: "COMP_STORE" | "COMP_DEFLATE"

压缩方式，COMP_STORE 为仅打包不压缩，COMP_DEFLATE 为压缩（默认）

---

defaultFolderPath

• Optional defaultFolderPath: string

压缩或添加文件时，指定文件在压缩包的默认文件夹位置。

---

encryptionMethod

• Optional encryptionMethod: "ENC_NO_ENCRYPTION" | "ENC_METHOD_STANDARD" | "ENC_METHOD_AES"

加密方法，ENC_NO_ENCRYPTION 为不加密（默认），ENC_METHOD_STANDARD 为标准加密，ENC_METHOD_AES 为 AES 加密

---

fileNameInZip

• Optional fileNameInZip: string

压缩或添加文件时，指定文件在压缩包中的路径、名称。

参见

• addFile
• addFolder

---

includeRootFolder

• Optional includeRootFolder: boolean

设置标志以指示添加文件的父文件夹是否将包含在 ZIP 中。如果为 true，则添加文件的父文件夹将包含在 ZIP 中。默认为 true。

参见

• addFolder
• zipDir

---

password

• Optional password: string

加密压缩的密码。如果设置密码但不设置加密方法，则加密方法默认为 AES。

---

readHiddenFiles

• Optional readHiddenFiles: boolean

压缩文件夹时是否包含隐藏文件。如果为 true，则在将文件夹添加到 zip 时将包含隐藏文件。默认为 true。

---

rootFolderInZip

• Optional rootFolderInZip: string

设置压缩包首目录的文件夹名称，如果没有首目录，则创建这个首目录。

参见

• addFolder
• zipDir