@types/inflation
Version:
TypeScript definitions for inflation
42 lines (32 loc) • 1.25 kB
Markdown
# Installation
> `npm install --save @types/inflation`
# Summary
This package contains type definitions for inflation (https://github.com/stream-utils/inflation#readme).
# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/inflation.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/inflation/index.d.ts)
````ts
/// <reference types="node" />
import { Readable } from "stream";
import { ZlibOptions } from "zlib";
export = inflate;
/**
* Automatically unzip an HTTP stream.
*
* @returns a stream that emits inflated data from the given stream.
*/
declare function inflate(req: Readable, options?: inflate.Options): Readable;
declare namespace inflate {
interface Options extends ZlibOptions {
/**
* The encoding of the stream. If not given, will look in `stream.headers['content-encoding']`.
*/
gzip?: "deflate" | "gzip" | "identity" | undefined;
}
}
````
### 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 [Remco Haszing](https://github.com/remcohaszing).