qiao-zip

4.5.2 • Public • Published

qiao-zip

npm version npm downloads

nodejs 下 zip 和 unzip 工具

  1. Node.js 压缩为 zip 文件:archiver
  2. Node.js 解压缩 zip 文件:adm-zip
  3. qiao-zip:Node.js 下 zip 和 unzip

install

安装

npm i qiao-zip

cli

也支持cli使用,详见qiao-zip-cli

use

使用

// cjs
const { zip, unzip } = require('qiao-zip');

// mjs
import { zip, unzip } from 'qiao-zip';

api

unzip

解压缩 zip 文件

  • zipFile
    • 类型: string
    • 说明: zip 文件路径
  • destFolder
    • 类型: string
    • 说明: 解压缩目标文件夹
  • return
    • 类型: boolean
    • 说明: 结果
    • true: 成功
const res = await unzip(zipFile, destFolder);

zip

压缩文件或文件夹

  • src
    • 类型: string
    • 说明: 待压缩的文件或者文件夹
  • dest
    • 类型: string
    • 说明: 压缩的目标路径
  • subdir
    • 类型: boolean
    • 说明: 是否包含文件夹
    • 默认值: false
  • return
    • 类型: boolean
    • 说明: 结果
    • true: 成功
const res = await zip(src, dest);

// subdir,是否需要包一层
const res = await zip(src, dest, true);

Package Sidebar

Install

npm i qiao-zip

Weekly Downloads

86

Version

4.5.2

License

MIT

Unpacked Size

8.08 kB

Total Files

7

Last publish

Collaborators

  • npm_insistime