# @types/s3-zip

> TypeScript definitions for s3-zip

Latest version **3.3.1** (published 2024-10-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/s3-zip
pnpm add @types/s3-zip
yarn add @types/s3-zip
bun add @types/s3-zip
```

## Health

**Score 55/100 (C)** — status: stable.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 3.3.1 |
| Published | 2024-10-23 |
| First published | 2023-12-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 4.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51446 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/s3-zip
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/s3-zip
- npm.io page: https://npm.io/package/@types/s3-zip

## Dependencies (2)

- [@types/archiver](https://npm.io/package/@types/archiver.md) ^6.0.2
- [@aws-sdk/client-s3](https://npm.io/package/@aws-sdk/client-s3.md) ^3.0.0

## Recent versions

- 3.3.1 (latest) — 2024-10-23
- 3.3.0 (ts4.6) — 2023-12-18
- 3.2.0 — 2023-12-16

## README

# Installation
> `npm install --save @types/s3-zip`

# Summary
This package contains type definitions for s3-zip (https://github.com/orangewise/s3-zip).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/s3-zip.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/s3-zip/index.d.ts)
````ts
import { S3Client } from "@aws-sdk/client-s3";
import { Archiver, ArchiverOptions, EntryData, Format } from "archiver";

declare namespace S3Zip {
    interface ArchiveOptions {
        s3?: S3Client;
        region?: string;
        bucket: string;
        debug?: boolean;
        preserveFolderStructure?: boolean;
    }
}

interface S3Zip {
    archive(
        opts: S3Zip.ArchiveOptions,
        folder: string | undefined,
        filesS3: string[],
        filesZip?: EntryData[],
    ): Archiver;

    setFormat(format: Format): this;

    setArchiverOptions(archiverOpts: ArchiverOptions): this;

    // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type -- Function
    setRegisterFormatOptions(registerFormat: string, formatModule: Function): this;
}

declare const S3Zip: S3Zip;

export = S3Zip;

````

### Additional Details
 * Last updated: Wed, 23 Oct 2024 03:36:41 GMT
 * Dependencies: [@aws-sdk/client-s3](https://npmjs.com/package/@aws-sdk/client-s3), [@types/archiver](https://npmjs.com/package/@types/archiver)

# Credits
These definitions were written by [Janick](https://github.com/janickvwcotiss).

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