@types/inflation v2.0.4

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

// Type definitions for inflation 2.0
// Project: https://github.com/stream-utils/inflation#readme
// Definitions by: Remco Haszing <https://github.com/remcohaszing>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/// <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: Thu, 08 Jul 2021 14:23:12 GMT
• Dependencies: @types/node
• Global values: none

Credits

These definitions were written by Remco Haszing.