# @types/unzip-stream

> TypeScript definitions for unzip-stream

Latest version **0.3.4** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/unzip-stream
pnpm add @types/unzip-stream
yarn add @types/unzip-stream
bun add @types/unzip-stream
```

## Health

**Score 45/100 (D)** — status: abandoned.

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

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.3.4 |
| Published | 2023-11-07 |
| First published | 2021-02-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51465 |
| Maintainers | types |

## Links

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

## Dependencies (1)

- [@types/node](https://npm.io/package/@types/node.md) *

## Recent versions

- 0.3.4 (latest) — 2023-11-07
- 0.3.2 (ts4.3) — 2023-08-30
- 0.3.1 (ts3.6) — 2021-07-02
- 0.3.0 (ts3.4) — 2021-02-17
- 0.3.3 — 2023-10-18

## README

# Installation
> `npm install --save @types/unzip-stream`

# Summary
This package contains type definitions for unzip-stream (https://github.com/mhr3/unzip-stream#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/unzip-stream.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/unzip-stream/index.d.ts)
````ts
/// <reference types="node" />

import { PassThrough } from "stream";

export function Extract(options: {
    path: string;
    /* used to decode non-utf8 file names in the archive. If not specified a fallback will be used. */
    decodeString?: ((buffer: Buffer) => string) | undefined;
}): NodeJS.WritableStream;

export function Parse(options?: {
    /* used to decode non-utf8 file names in the archive. If not specified a fallback will be used. */
    decodeString?: ((buffer: Buffer) => string) | undefined;
}): NodeJS.WritableStream & NodeJS.ReadableStream;

export interface Entry extends PassThrough {
    path: string;
    type: "Directory" | "File";
    size: number;
    autodrain: () => void;
}

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 15:11:36 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)

# Credits
These definitions were written by [Kyle Hensel](https://github.com/k-yle).

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