@types/node 20.12.7 → 20.12.9

node/zlib.d.ts

@@ -8,7 +8,8 @@
  * const zlib = require('node:zlib');
  * ```
  *
- * Compression and decompression are built around the Node.js `Streams API`.
+ * Compression and decompression are built around the Node.js
+ * [Streams API](https://nodejs.org/docs/latest-v20.x/api/stream.html).
  *
  * Compressing or decompressing a stream (such as a file) can be accomplished by
  * piping the source stream through a `zlib` `Transform` stream into a destination
@@ -88,7 +89,7 @@
  *   });
  * ```
  * @since v0.5.8
- * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/zlib.js)
+ * @see [source](https://github.com/nodejs/node/blob/v20.12.2/lib/zlib.js)
  */
 declare module "zlib" {
     import * as stream from "node:stream";
@@ -110,7 +111,14 @@ declare module "zlib" {
         memLevel?: number | undefined; // compression only
         strategy?: number | undefined; // compression only
         dictionary?: NodeJS.ArrayBufferView | ArrayBuffer | undefined; // deflate/inflate only, empty dictionary by default
+        /**
+         * If `true`, returns an object with `buffer` and `engine`.
+         */
         info?: boolean | undefined;
+        /**
+         * Limits output size when using convenience methods.
+         * @default buffer.kMaxLength
+         */
         maxOutputLength?: number | undefined;
     }
     interface BrotliOptions {
@@ -134,6 +142,10 @@ declare module "zlib" {
                 [key: number]: boolean | number;
             }
             | undefined;
+        /**
+         * Limits output size when using [convenience methods](https://nodejs.org/docs/latest-v20.x/api/zlib.html#convenience-methods).
+         * @default buffer.kMaxLength
+         */
         maxOutputLength?: number | undefined;
     }
     interface Zlib {
@@ -194,7 +206,7 @@ declare module "zlib" {
     /**
      * Creates and returns a new `DeflateRaw` object.
      *
-     * An upgrade of zlib from 1.2.8 to 1.2.11 changed behavior when `windowBits`is set to 8 for raw deflate streams. zlib would automatically set `windowBits`to 9 if was initially set to 8\. Newer
+     * An upgrade of zlib from 1.2.8 to 1.2.11 changed behavior when `windowBits` is set to 8 for raw deflate streams. zlib would automatically set `windowBits` to 9 if was initially set to 8. Newer
      * versions of zlib will throw an exception,
      * so Node.js restored the original behavior of upgrading a value of 8 to 9,
      * since passing `windowBits = 9` to zlib actually results in a compressed stream
@@ -433,6 +445,7 @@ declare module "zlib" {
         const Z_FIXED: number;
         const Z_DEFAULT_STRATEGY: number;
         const Z_DEFAULT_WINDOWBITS: number;
+
         const Z_MIN_WINDOWBITS: number;
         const Z_MAX_WINDOWBITS: number;
         const Z_MIN_CHUNK: number;