🤖 Merge PR DefinitelyTyped#74603 [@types/brotli]: update types by @arturovt

Author: arturovt

types/brotli/brotli-tests.ts

@@ -2,12 +2,12 @@ import * as brotli from "brotli";
 import compress = require("brotli/compress");
 import decompress = require("brotli/decompress");
 
-// $ExpectType Uint8Array || Uint8Array<ArrayBufferLike>
+// $ExpectType Uint8Array | null || Uint8Array<ArrayBufferLike> | null
 brotli.compress(Buffer.from("hello"));
 // $ExpectType Uint8Array || Uint8Array<ArrayBufferLike>
 brotli.decompress(Buffer.from("hello"));
 
-// $ExpectType Uint8Array || Uint8Array<ArrayBufferLike>
+// $ExpectType Uint8Array | null || Uint8Array<ArrayBufferLike> | null
 compress(Buffer.from("hello"));
 compress(Buffer.from("hello"), {});
 // $ExpectType Uint8Array || Uint8Array<ArrayBufferLike>

types/brotli/compress.d.ts

@@ -1,21 +1,35 @@
 interface CompressOptions {
     /**
-     * The Brotli compression mode. Possible modes are:
-     * 0 - generic (default)
-     * 1 - text (for UTF-8 format text input)
-     * 2 - font (WOFF2)
+     * The Brotli compression mode:
+     * - `0` - generic (default)
+     * - `1` - text (for UTF-8 format text input)
+     * - `2` - font (WOFF2)
      */
     mode?: 0 | 1 | 2 | undefined;
     /**
-     * The Brotli quality level, possible levels are 0-11. The default level is 11.
+     * The Brotli quality level, ranging from 0 (fastest) to 11 (best compression).
+     * @default 11
      */
     quality?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | undefined;
     /**
-     * The LZ77 window size, default is 22.
+     * The LZ77 window size. Valid range is 10-24.
+     * @default 22
      */
     lgwin?: number | undefined;
+    /**
+     * An optional pre-shared dictionary to improve compression ratio.
+     * Both the compressor and decompressor must use the same dictionary.
+     */
+    dictionary?: string | undefined;
 }
 
-declare function compress(buffer: Buffer, options?: CompressOptions): Uint8Array;
+/**
+ * Compresses the given buffer using the Brotli algorithm.
+ * Returns `null` on error.
+ *
+ * @param buffer - The input data to compress.
+ * @param options - Optional compression settings.
+ */
+declare function compress(buffer: Buffer, options?: CompressOptions): Uint8Array | null;
 
 export = compress;

types/brotli/decompress.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Decompresses a Brotli-compressed buffer.
+ *
+ * @param buffer - A Brotli-compressed buffer.
+ * @param outputSize - Optional expected output size. If not provided, it will
+ *   be determined automatically by reading the meta-block header.
+ */
 declare function decompress(buffer: Buffer, outputSize?: number): Uint8Array;
 
 export = decompress;

types/brotli/package.json

@@ -13,7 +13,7 @@
     },
     "owners": [
         {
-            "name": "Artur Androsovych",
+            "name": "arturovt",
             "githubUsername": "arturovt"
         }
     ]