DefinitelyTyped/types/compression/index.d.ts

// Type definitions for compression
// Project: https://github.com/expressjs/compression
// Definitions by: Santi Albo <https://github.com/santialbo>
//                 Rob van der Burgt <https://github.com/rburgt>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.2

import * as express from 'express';

declare function e(options?: e.CompressionOptions): express.RequestHandler;

declare namespace e {
    /**
     * Default filter, used for extending filter given in CompressionOptions
     * See https://github.com/expressjs/compression#filter-1 regarding the usage
     */
    export function filter(req: express.Request, res: express.Response): boolean;

    interface CompressionFilter {
        (req: express.Request, res: express.Response): boolean;
    }

    interface CompressionOptions {
        /**
         * See https://github.com/expressjs/compression#chunksize regarding the usage.
         */
        chunkSize?: number;

        /**
         * See https://github.com/expressjs/compression#level regarding the usage.
         */
        level?: number;

        /**
         * See https://github.com/expressjs/compression#memlevel regarding the usage.
         */
        memLevel?: number;

        /**
         * See https://github.com/expressjs/compression#strategy regarding the usage.
         */
        strategy?: number;

        /**
         * See https://github.com/expressjs/compression#threshold regarding the usage.
         */
        threshold?: number | string;

        /**
         * See https://github.com/expressjs/compression#windowbits regarding the usage.
         */
        windowBits?: number;

        /**
         * See https://github.com/expressjs/compression#filter regarding the usage.
         */
        filter?: CompressionFilter;

        /**
         * See https://nodejs.org/api/zlib.html#zlib_class_options regarding the usage.
         */
        flush?: number;

        /**
         * See https://nodejs.org/api/zlib.html#zlib_class_options regarding the usage.
         */
        finishFlush?: number;
    }
}

export = e;