🤖 Merge PR DefinitelyTyped#72755 feat(compression): add brotli options and enforceEncoding support by @bjohansebas

Signed-off-by: Sebastian Beltran <bjohansebas@gmail.com>

Author: bjohansebas

types/compression/compression-tests.ts

@@ -20,6 +20,13 @@ app.use(
         flush: zlib.constants.Z_NO_FLUSH,
         finishFlush: zlib.constants.Z_FINISH,
         dictionary: Buffer.from("Hello World!"),
+        // brotli options
+        brotli: {
+            params: {
+                [zlib.constants.BROTLI_PARAM_QUALITY]: 4,
+                [zlib.constants.BROTLI_PARAM_MODE]: zlib.constants.BROTLI_DEFAULT_MODE,
+            },
+        },
         info: true,
     }),
 );
@@ -38,6 +45,8 @@ app.use(
     }),
 );
 
+app.use(compression({ enforceEncoding: "br" }));
+
 // compression.filter
 
 app.use(compression({ filter: shouldCompress }));

types/compression/index.d.ts

@@ -1,4 +1,5 @@
 import express = require("express");
+import * as zlib from "zlib";
 
 // This module adds a res.flush() method to force the partially-compressed response to be flushed to the client.
 
@@ -81,6 +82,17 @@ declare namespace compression {
          */
         filter?: CompressionFilter | undefined;
 
+        /**
+         * Options for brotli compression.
+         */
+        brotli?: zlib.BrotliOptions | undefined;
+
+        /**
+         * This is the default encoding to use when the client does not specify an encoding in the request's Accept-Encoding header.
+         * @default 'identity'
+         */
+        enforceEncoding?: string | undefined;
+
         /**
          * The level of zlib compression to apply to responses. A higher level will result in better compression, but
          * will take longer to complete. A lower level will result in less compression, but will be much faster.

types/compression/package.json

@@ -1,16 +1,16 @@
 {
     "private": true,
     "name": "@types/compression",
-    "version": "1.7.9999",
+    "version": "1.8.9999",
     "projects": [
         "https://github.com/expressjs/compression"
     ],
     "dependencies": {
-        "@types/express": "*"
+        "@types/express": "*",
+        "@types/node": "*"
     },
     "devDependencies": {
-        "@types/compression": "workspace:.",
-        "@types/node": "*"
+        "@types/compression": "workspace:."
     },
     "owners": [
         {