# @types/gulp-gzip

> TypeScript definitions for gulp-gzip

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

## Install

```sh
npm install @types/gulp-gzip
pnpm add @types/gulp-gzip
yarn add @types/gulp-gzip
bun add @types/gulp-gzip
```

## 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.0.36 |
| Published | 2023-11-07 |
| First published | 2016-05-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51449 |
| Maintainers | types |

## Links

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

## Dependencies (1)

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

## Recent versions

- 0.0.36 (latest) — 2023-11-07
- 0.0.33 (ts4.3) — 2023-05-10
- 0.0.32 (ts3.6) — 2021-07-08
- 0.0.31 (ts2.0) — 2017-11-08
- 0.0.35 — 2023-10-18
- 0.0.34 — 2023-09-20
- 0.0.30 — 2017-03-16
- 0.0.29 — 2016-09-19
- 0.0.28 — 2016-07-14
- 0.0.27-alpha — 2016-07-08
- 0.0.26-alpha — 2016-07-04
- 0.0.25-alpha — 2016-07-02
- 0.0.24-alpha — 2016-07-01
- 0.0.23-alpha — 2016-07-01
- 0.0.22-alpha — 2016-05-25
- … 3 more at https://npm.io/package/@types/gulp-gzip/versions

## README

# Installation
> `npm install --save @types/gulp-gzip`

# Summary
This package contains type definitions for gulp-gzip (https://github.com/jstuckey/gulp-gzip).

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

import zlib = require("zlib");

declare namespace gzip {
    interface Gzip {
        (options?: Options): NodeJS.ReadWriteStream;
    }

    interface Options {
        /**
         * Appends .gz file extension if true.
         * @default true
         */
        append?: boolean | undefined;
        /**
         * Appends an arbitrary extension to the filename. Disables append and preExtension options.
         */
        extension?: string | undefined;
        /**
         * Appends an arbitrary pre-extension to the filename. Disables append and extension options.
         */
        preExtension?: string | undefined;
        /**
         * Minimum size required to compress a file.
         * @default false
         */
        threshold?: number | string | boolean | undefined;
        /**
         * Options object to pass through to zlib.Gzip.
         * See <a href='https://nodejs.org/api/zlib.html#zlib_options'>zlib</a> documentation for more information.
         */
        gzipOptions?: zlib.ZlibOptions | undefined;
    }
}

declare var gzip: gzip.Gzip;

export = gzip;

````

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

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

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