Options
显示所有项
  • 仅显示公有项
  • 显示保护/公有项
  • 显示所有项
Menu

压缩选项。

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

zipDir

参见

zipFiles

参见

zipFile

参见

ZipFile.addFolder

参见

ZipFile.addFile

参见

ZipFile.addFiles

继承关系

  • ZipOptions

索引

属性

可选 aesKeyStrength

aesKeyStrength: "AES_STRENGTH_128" | "AES_STRENGTH_192" | "AES_STRENGTH_256"

AES加密强度,包括AES_STRENGTH_128AES_STRENGTH_192AES_STRENGTH_256

可选 compressionLevel

compressionLevel: number

压缩级别,0~9,0为不压缩,9为最好压缩(速度较慢)。默认为5(正常压缩)。

可选 compressionMethod

compressionMethod: "COMP_STORE" | "COMP_DEFLATE"

压缩方式,COMP_STORE为仅打包不压缩, COMP_DEFLATE为压缩(默认)

可选 defaultFolderPath

defaultFolderPath: string

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

可选 encryptionMethod

encryptionMethod: "ENC_NO_ENCRYPTION" | "ENC_METHOD_STANDARD" | "ENC_METHOD_AES"

加密方法,ENC_NO_ENCRYPTION为不加密(默认),ENC_METHOD_STANDARD为标准机密, ENC_METHOD_AES为AES加密

可选 fileNameInZip

fileNameInZip: string

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

参见

ZipFile.addFile

参见

ZipFile.addFolder

可选 includeRootFolder

includeRootFolder: boolean

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

参见

ZipFile.addFolder

参见

zipDir

可选 password

password: string

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

可选 readHiddenFiles

readHiddenFiles: boolean

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

可选 rootFolderInZip

rootFolderInZip: string

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

参见

ZipFile.addFolder

参见

zipDir