# @serverless-devs/zip

> zip for serverless-devs

Latest version **0.0.3-beta.8** (published 2023-11-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install @serverless-devs/zip
pnpm add @serverless-devs/zip
yarn add @serverless-devs/zip
bun add @serverless-devs/zip
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.0.3-beta.8 |
| Published | 2023-11-29 |
| First published | 2023-06-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 20.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | wss-git |
| Maintainers | serverlessfans, heimanba, xsahxl |

## Links

- npm: https://www.npmjs.com/package/@serverless-devs/zip
- Repository: https://github.com/Serverless-Devs/toolkit
- Homepage: https://github.com/Serverless-Devs/toolkit#readme
- Issues: https://github.com/Serverless-Devs/toolkit/issues
- npm.io page: https://npm.io/package/@serverless-devs/zip

## Dependencies (8)

- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [archiver](https://npm.io/package/archiver.md) ^5.3.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^11.1.0
- [readline](https://npm.io/package/readline.md) ^1.3.0
- [minimatch](https://npm.io/package/minimatch.md) ^9.0.1
- [@serverless-devs/ignore-walk](https://npm.io/package/@serverless-devs/ignore-walk.md) ^0.0.1
- [@serverless-devs/progress-bar](https://npm.io/package/@serverless-devs/progress-bar.md) ^0.0.1

## Recent versions

- 0.0.3-beta.8 (latest) — 2023-11-29
- 0.0.3-beta.1 (beta) — 2023-07-03
- 0.0.3-beta.7 — 2023-11-29
- 0.0.3-beta.6 — 2023-09-12
- 0.0.3-beta.5 — 2023-08-21
- 0.0.3-beta.4 — 2023-08-18
- 0.0.3-beta.3 — 2023-08-18
- 0.0.3-beta.2 — 2023-07-18
- 0.0.2 — 2023-06-28
- 0.0.1 — 2023-06-16

## README

# 压缩(@serverless-devs/zip)

## 安装

```bash
$ npm install @serverless-devs/zip --save
```

## 基本使用

```ts
import zip from '@serverless-devs/zip';

zip({ codeUri: './code' })
```

## 参数解析

```ts
import zip from '@serverless-devs/zip';
const result = await zip(options)
```

## Options

| 参数      | 说明         | 类型                          | 必填 | 默认值        |
| --------- | ------------ | ----------------------------- | ---- | ------------- |
| codeUri    | 代码包路径   |  string     | 是   |  - |
| includes    | 额外的压缩代码目录   |  string[]     | 否   |  - |
| outputFilePath    | 压缩文件输出目录   |  string     | 否   |  `process.cwd()` |
| outputFileName    | 压缩文件输出名称   |  string     | 否   |  `${Date.now()}.zip` |
| ignoreFiles    | 代码包忽略声明文件名称   |  string[]     | 否   |  `['.signore']` |
| level    | 压缩级别   |  number     | 否   |  9 |
| prefix    | 新增压缩目录前缀   |  string     | 否   |  - |

## Result

| 参数      | 说明   | 类型   |
| --------- | ------------ | ---- |
| count | 被压缩的文件个数 | number |
| compressedSize | 生成文件的大小 | number |
| outputFile | 生成文件的本地地址 | string |

---
_Source: https://npm.io/package/@serverless-devs/zip · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._