{
  "type": "module",
  "source": "doc/api/zlib.md",
  "modules": [
    {
      "textRaw": "Zlib",
      "name": "zlib",
      "introduced_in": "v0.10.0",
      "type": "module",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "<p>The <code>node:zlib</code> module provides compression functionality implemented using\nGzip, Deflate/Inflate, Brotli, and Zstd.</p>\n<p>To access it:</p>\n<pre><code class=\"language-mjs\">import zlib from 'node:zlib';\n</code></pre>\n<pre><code class=\"language-cjs\">const zlib = require('node:zlib');\n</code></pre>\n<p>Compression and decompression are built around the Node.js <a href=\"stream.html\">Streams API</a>.</p>\n<p>Compressing or decompressing a stream (such as a file) can be accomplished by\npiping the source stream through a <code>zlib</code> <code>Transform</code> stream into a destination\nstream:</p>\n<pre><code class=\"language-mjs\">import {\n  createReadStream,\n  createWriteStream,\n} from 'node:fs';\nimport process from 'node:process';\nimport { createGzip } from 'node:zlib';\nimport { pipeline } from 'node:stream';\n\nconst gzip = createGzip();\nconst source = createReadStream('input.txt');\nconst destination = createWriteStream('input.txt.gz');\n\npipeline(source, gzip, destination, (err) => {\n  if (err) {\n    console.error('An error occurred:', err);\n    process.exitCode = 1;\n  }\n});\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n  createReadStream,\n  createWriteStream,\n} = require('node:fs');\nconst { createGzip } = require('node:zlib');\nconst { pipeline } = require('node:stream');\n\nconst gzip = createGzip();\nconst source = createReadStream('input.txt');\nconst destination = createWriteStream('input.txt.gz');\n\npipeline(source, gzip, destination, (err) => {\n  if (err) {\n    console.error('An error occurred:', err);\n    process.exitCode = 1;\n  }\n});\n</code></pre>\n<p>Or, using the promise <code>pipeline</code> API:</p>\n<pre><code class=\"language-mjs\">import {\n  createReadStream,\n  createWriteStream,\n} from 'node:fs';\nimport { createGzip } from 'node:zlib';\nimport { pipeline } from 'node:stream/promises';\n\nasync function do_gzip(input, output) {\n  const gzip = createGzip();\n  const source = createReadStream(input);\n  const destination = createWriteStream(output);\n  await pipeline(source, gzip, destination);\n}\n\nawait do_gzip('input.txt', 'input.txt.gz');\n</code></pre>\n<pre><code class=\"language-cjs\">const {\n  createReadStream,\n  createWriteStream,\n} = require('node:fs');\nconst { createGzip } = require('node:zlib');\nconst { pipeline } = require('node:stream/promises');\n\nasync function do_gzip(input, output) {\n  const gzip = createGzip();\n  const source = createReadStream(input);\n  const destination = createWriteStream(output);\n  await pipeline(source, gzip, destination);\n}\n\ndo_gzip('input.txt', 'input.txt.gz')\n  .catch((err) => {\n    console.error('An error occurred:', err);\n    process.exitCode = 1;\n  });\n</code></pre>\n<p>It is also possible to compress or decompress data in a single step:</p>\n<pre><code class=\"language-mjs\">import process from 'node:process';\nimport { Buffer } from 'node:buffer';\nimport { deflate, unzip } from 'node:zlib';\n\nconst input = '.................................';\ndeflate(input, (err, buffer) => {\n  if (err) {\n    console.error('An error occurred:', err);\n    process.exitCode = 1;\n  }\n  console.log(buffer.toString('base64'));\n});\n\nconst buffer = Buffer.from('eJzT0yMAAGTvBe8=', 'base64');\nunzip(buffer, (err, buffer) => {\n  if (err) {\n    console.error('An error occurred:', err);\n    process.exitCode = 1;\n  }\n  console.log(buffer.toString());\n});\n\n// Or, Promisified\n\nimport { promisify } from 'node:util';\nconst do_unzip = promisify(unzip);\n\nconst unzippedBuffer = await do_unzip(buffer);\nconsole.log(unzippedBuffer.toString());\n</code></pre>\n<pre><code class=\"language-cjs\">const { deflate, unzip } = require('node:zlib');\n\nconst input = '.................................';\ndeflate(input, (err, buffer) => {\n  if (err) {\n    console.error('An error occurred:', err);\n    process.exitCode = 1;\n  }\n  console.log(buffer.toString('base64'));\n});\n\nconst buffer = Buffer.from('eJzT0yMAAGTvBe8=', 'base64');\nunzip(buffer, (err, buffer) => {\n  if (err) {\n    console.error('An error occurred:', err);\n    process.exitCode = 1;\n  }\n  console.log(buffer.toString());\n});\n\n// Or, Promisified\n\nconst { promisify } = require('node:util');\nconst do_unzip = promisify(unzip);\n\ndo_unzip(buffer)\n  .then((buf) => console.log(buf.toString()))\n  .catch((err) => {\n    console.error('An error occurred:', err);\n    process.exitCode = 1;\n  });\n</code></pre>",
      "modules": [
        {
          "textRaw": "Threadpool usage and performance considerations",
          "name": "threadpool_usage_and_performance_considerations",
          "type": "module",
          "desc": "<p>All <code>zlib</code> APIs, except those that are explicitly synchronous, use the Node.js\ninternal threadpool. This can lead to surprising effects and performance\nlimitations in some applications.</p>\n<p>Creating and using a large number of zlib objects simultaneously can cause\nsignificant memory fragmentation.</p>\n<pre><code class=\"language-mjs\">import zlib from 'node:zlib';\nimport { Buffer } from 'node:buffer';\n\nconst payload = Buffer.from('This is some data');\n\n// WARNING: DO NOT DO THIS!\nfor (let i = 0; i &#x3C; 30000; ++i) {\n  zlib.deflate(payload, (err, buffer) => {});\n}\n</code></pre>\n<pre><code class=\"language-cjs\">const zlib = require('node:zlib');\n\nconst payload = Buffer.from('This is some data');\n\n// WARNING: DO NOT DO THIS!\nfor (let i = 0; i &#x3C; 30000; ++i) {\n  zlib.deflate(payload, (err, buffer) => {});\n}\n</code></pre>\n<p>In the preceding example, 30,000 deflate instances are created concurrently.\nBecause of how some operating systems handle memory allocation and\ndeallocation, this may lead to significant memory fragmentation.</p>\n<p>It is strongly recommended that the results of compression\noperations be cached to avoid duplication of effort.</p>",
          "displayName": "Threadpool usage and performance considerations"
        },
        {
          "textRaw": "Compressing HTTP requests and responses",
          "name": "compressing_http_requests_and_responses",
          "type": "module",
          "desc": "<p>The <code>node:zlib</code> module can be used to implement support for the <code>gzip</code>, <code>deflate</code>,\n<code>br</code>, and <code>zstd</code> content-encoding mechanisms defined by\n<a href=\"https://tools.ietf.org/html/rfc7230#section-4.2\">HTTP</a>.</p>\n<p>The HTTP <a href=\"https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3\"><code>Accept-Encoding</code></a> header is used within an HTTP request to identify\nthe compression encodings accepted by the client. The <a href=\"https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11\"><code>Content-Encoding</code></a>\nheader is used to identify the compression encodings actually applied to a\nmessage.</p>\n<p>The examples given below are drastically simplified to show the basic concept.\nUsing <code>zlib</code> encoding can be expensive, and the results ought to be cached.\nSee <a href=\"#memory-usage-tuning\">Memory usage tuning</a> for more information on the speed/memory/compression\ntradeoffs involved in <code>zlib</code> usage.</p>\n<pre><code class=\"language-mjs\">// Client request example\nimport fs from 'node:fs';\nimport zlib from 'node:zlib';\nimport http from 'node:http';\nimport process from 'node:process';\nimport { pipeline } from 'node:stream';\n\nconst request = http.get({ host: 'example.com',\n                           path: '/',\n                           port: 80,\n                           headers: { 'Accept-Encoding': 'br,gzip,deflate,zstd' } });\nrequest.on('response', (response) => {\n  const output = fs.createWriteStream('example.com_index.html');\n\n  const onError = (err) => {\n    if (err) {\n      console.error('An error occurred:', err);\n      process.exitCode = 1;\n    }\n  };\n\n  switch (response.headers['content-encoding']) {\n    case 'br':\n      pipeline(response, zlib.createBrotliDecompress(), output, onError);\n      break;\n    // Or, just use zlib.createUnzip() to handle both of the following cases:\n    case 'gzip':\n      pipeline(response, zlib.createGunzip(), output, onError);\n      break;\n    case 'deflate':\n      pipeline(response, zlib.createInflate(), output, onError);\n      break;\n    case 'zstd':\n      pipeline(response, zlib.createZstdDecompress(), output, onError);\n      break;\n    default:\n      pipeline(response, output, onError);\n      break;\n  }\n});\n</code></pre>\n<pre><code class=\"language-cjs\">// Client request example\nconst zlib = require('node:zlib');\nconst http = require('node:http');\nconst fs = require('node:fs');\nconst { pipeline } = require('node:stream');\n\nconst request = http.get({ host: 'example.com',\n                           path: '/',\n                           port: 80,\n                           headers: { 'Accept-Encoding': 'br,gzip,deflate,zstd' } });\nrequest.on('response', (response) => {\n  const output = fs.createWriteStream('example.com_index.html');\n\n  const onError = (err) => {\n    if (err) {\n      console.error('An error occurred:', err);\n      process.exitCode = 1;\n    }\n  };\n\n  switch (response.headers['content-encoding']) {\n    case 'br':\n      pipeline(response, zlib.createBrotliDecompress(), output, onError);\n      break;\n    // Or, just use zlib.createUnzip() to handle both of the following cases:\n    case 'gzip':\n      pipeline(response, zlib.createGunzip(), output, onError);\n      break;\n    case 'deflate':\n      pipeline(response, zlib.createInflate(), output, onError);\n      break;\n    case 'zstd':\n      pipeline(response, zlib.createZstdDecompress(), output, onError);\n      break;\n    default:\n      pipeline(response, output, onError);\n      break;\n  }\n});\n</code></pre>\n<pre><code class=\"language-mjs\">// server example\n// Running a gzip operation on every request is quite expensive.\n// It would be much more efficient to cache the compressed buffer.\nimport zlib from 'node:zlib';\nimport http from 'node:http';\nimport fs from 'node:fs';\nimport { pipeline } from 'node:stream';\n\nhttp.createServer((request, response) => {\n  const raw = fs.createReadStream('index.html');\n  // Store both a compressed and an uncompressed version of the resource.\n  response.setHeader('Vary', 'Accept-Encoding');\n  const acceptEncoding = request.headers['accept-encoding'] || '';\n\n  const onError = (err) => {\n    if (err) {\n      // If an error occurs, there's not much we can do because\n      // the server has already sent the 200 response code and\n      // some amount of data has already been sent to the client.\n      // The best we can do is terminate the response immediately\n      // and log the error.\n      response.end();\n      console.error('An error occurred:', err);\n    }\n  };\n\n  // Note: This is not a conformant accept-encoding parser.\n  // See https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3\n  if (/\\bdeflate\\b/.test(acceptEncoding)) {\n    response.writeHead(200, { 'Content-Encoding': 'deflate' });\n    pipeline(raw, zlib.createDeflate(), response, onError);\n  } else if (/\\bgzip\\b/.test(acceptEncoding)) {\n    response.writeHead(200, { 'Content-Encoding': 'gzip' });\n    pipeline(raw, zlib.createGzip(), response, onError);\n  } else if (/\\bbr\\b/.test(acceptEncoding)) {\n    response.writeHead(200, { 'Content-Encoding': 'br' });\n    pipeline(raw, zlib.createBrotliCompress(), response, onError);\n  } else if (/\\bzstd\\b/.test(acceptEncoding)) {\n    response.writeHead(200, { 'Content-Encoding': 'zstd' });\n    pipeline(raw, zlib.createZstdCompress(), response, onError);\n  } else {\n    response.writeHead(200, {});\n    pipeline(raw, response, onError);\n  }\n}).listen(1337);\n</code></pre>\n<pre><code class=\"language-cjs\">// server example\n// Running a gzip operation on every request is quite expensive.\n// It would be much more efficient to cache the compressed buffer.\nconst zlib = require('node:zlib');\nconst http = require('node:http');\nconst fs = require('node:fs');\nconst { pipeline } = require('node:stream');\n\nhttp.createServer((request, response) => {\n  const raw = fs.createReadStream('index.html');\n  // Store both a compressed and an uncompressed version of the resource.\n  response.setHeader('Vary', 'Accept-Encoding');\n  const acceptEncoding = request.headers['accept-encoding'] || '';\n\n  const onError = (err) => {\n    if (err) {\n      // If an error occurs, there's not much we can do because\n      // the server has already sent the 200 response code and\n      // some amount of data has already been sent to the client.\n      // The best we can do is terminate the response immediately\n      // and log the error.\n      response.end();\n      console.error('An error occurred:', err);\n    }\n  };\n\n  // Note: This is not a conformant accept-encoding parser.\n  // See https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3\n  if (/\\bdeflate\\b/.test(acceptEncoding)) {\n    response.writeHead(200, { 'Content-Encoding': 'deflate' });\n    pipeline(raw, zlib.createDeflate(), response, onError);\n  } else if (/\\bgzip\\b/.test(acceptEncoding)) {\n    response.writeHead(200, { 'Content-Encoding': 'gzip' });\n    pipeline(raw, zlib.createGzip(), response, onError);\n  } else if (/\\bbr\\b/.test(acceptEncoding)) {\n    response.writeHead(200, { 'Content-Encoding': 'br' });\n    pipeline(raw, zlib.createBrotliCompress(), response, onError);\n  } else if (/\\bzstd\\b/.test(acceptEncoding)) {\n    response.writeHead(200, { 'Content-Encoding': 'zstd' });\n    pipeline(raw, zlib.createZstdCompress(), response, onError);\n  } else {\n    response.writeHead(200, {});\n    pipeline(raw, response, onError);\n  }\n}).listen(1337);\n</code></pre>\n<p>By default, the <code>zlib</code> methods will throw an error when decompressing\ntruncated data. However, if it is known that the data is incomplete, or\nthe desire is to inspect only the beginning of a compressed file, it is\npossible to suppress the default error handling by changing the flushing\nmethod that is used to decompress the last chunk of input data:</p>\n<pre><code class=\"language-js\">// This is a truncated version of the buffer from the above examples\nconst buffer = Buffer.from('eJzT0yMA', 'base64');\n\nzlib.unzip(\n  buffer,\n  // For Brotli, the equivalent is zlib.constants.BROTLI_OPERATION_FLUSH.\n  // For Zstd, the equivalent is zlib.constants.ZSTD_e_flush.\n  { finishFlush: zlib.constants.Z_SYNC_FLUSH },\n  (err, buffer) => {\n    if (err) {\n      console.error('An error occurred:', err);\n      process.exitCode = 1;\n    }\n    console.log(buffer.toString());\n  });\n</code></pre>\n<p>This will not change the behavior in other error-throwing situations, e.g.\nwhen the input data has an invalid format. Using this method, it will not be\npossible to determine whether the input ended prematurely or lacks the\nintegrity checks, making it necessary to manually check that the\ndecompressed result is valid.</p>",
          "displayName": "Compressing HTTP requests and responses"
        },
        {
          "textRaw": "Flushing",
          "name": "flushing",
          "type": "module",
          "desc": "<p>Calling <a href=\"#zlibflushkind-callback\"><code>.flush()</code></a> on a compression stream will make <code>zlib</code> return as much\noutput as currently possible. This may come at the cost of degraded compression\nquality, but can be useful when data needs to be available as soon as possible.</p>\n<p>In the following example, <code>flush()</code> is used to write a compressed partial\nHTTP response to the client:</p>\n<pre><code class=\"language-mjs\">import zlib from 'node:zlib';\nimport http from 'node:http';\nimport { pipeline } from 'node:stream';\n\nhttp.createServer((request, response) => {\n  // For the sake of simplicity, the Accept-Encoding checks are omitted.\n  response.writeHead(200, { 'content-encoding': 'gzip' });\n  const output = zlib.createGzip();\n  let i;\n\n  pipeline(output, response, (err) => {\n    if (err) {\n      // If an error occurs, there's not much we can do because\n      // the server has already sent the 200 response code and\n      // some amount of data has already been sent to the client.\n      // The best we can do is terminate the response immediately\n      // and log the error.\n      clearInterval(i);\n      response.end();\n      console.error('An error occurred:', err);\n    }\n  });\n\n  i = setInterval(() => {\n    output.write(`The current time is ${Date()}\\n`, () => {\n      // The data has been passed to zlib, but the compression algorithm may\n      // have decided to buffer the data for more efficient compression.\n      // Calling .flush() will make the data available as soon as the client\n      // is ready to receive it.\n      output.flush();\n    });\n  }, 1000);\n}).listen(1337);\n</code></pre>\n<pre><code class=\"language-cjs\">const zlib = require('node:zlib');\nconst http = require('node:http');\nconst { pipeline } = require('node:stream');\n\nhttp.createServer((request, response) => {\n  // For the sake of simplicity, the Accept-Encoding checks are omitted.\n  response.writeHead(200, { 'content-encoding': 'gzip' });\n  const output = zlib.createGzip();\n  let i;\n\n  pipeline(output, response, (err) => {\n    if (err) {\n      // If an error occurs, there's not much we can do because\n      // the server has already sent the 200 response code and\n      // some amount of data has already been sent to the client.\n      // The best we can do is terminate the response immediately\n      // and log the error.\n      clearInterval(i);\n      response.end();\n      console.error('An error occurred:', err);\n    }\n  });\n\n  i = setInterval(() => {\n    output.write(`The current time is ${Date()}\\n`, () => {\n      // The data has been passed to zlib, but the compression algorithm may\n      // have decided to buffer the data for more efficient compression.\n      // Calling .flush() will make the data available as soon as the client\n      // is ready to receive it.\n      output.flush();\n    });\n  }, 1000);\n}).listen(1337);\n</code></pre>",
          "displayName": "Flushing"
        },
        {
          "textRaw": "Iterable Compression",
          "name": "iterable_compression",
          "type": "module",
          "meta": {
            "added": [
              "v25.9.0"
            ],
            "changes": []
          },
          "stability": 1,
          "stabilityText": "Experimental",
          "desc": "<p>The <code>node:zlib/iter</code> module provides compression and decompression transforms\nfor use with the <a href=\"stream_iter.html\"><code>node:stream/iter</code></a> iterable streams API.</p>\n<p>This module is available only when the <code>--experimental-stream-iter</code> CLI flag\nis enabled.</p>\n<p>Each algorithm has both an async variant (stateful async generator, for use\nwith <a href=\"stream_iter.html#pullsource-transforms-options\"><code>pull()</code></a> and <a href=\"stream_iter.html#pipetosource-transforms-writer-options\"><code>pipeTo()</code></a>) and a sync variant (stateful sync\ngenerator, for use with <code>pullSync()</code> and <code>pipeToSync()</code>).</p>\n<p>The async transforms run compression on the libuv threadpool, overlapping\nI/O with JavaScript execution. The sync transforms run compression directly\non the main thread.</p>\n<blockquote>\n<p>Note: The defaults for these transforms are tuned for streaming throughput,\nand differ from the defaults in <code>node:zlib</code>. In particular, gzip/deflate\ndefault to level 4 (not 6) and memLevel 9 (not 8), and Brotli defaults to\nquality 6 (not 11). These choices match common HTTP server configurations\nand provide significantly faster compression with only a small reduction in\ncompression ratio. All defaults can be overridden via options.</p>\n</blockquote>\n<pre><code class=\"language-mjs\">import { from, pull, bytes, text } from 'node:stream/iter';\nimport { compressGzip, decompressGzip } from 'node:zlib/iter';\n\n// Async round-trip\nconst compressed = await bytes(pull(from('hello'), compressGzip()));\nconst original = await text(pull(from(compressed), decompressGzip()));\nconsole.log(original); // 'hello'\n</code></pre>\n<pre><code class=\"language-cjs\">const { from, pull, bytes, text } = require('node:stream/iter');\nconst { compressGzip, decompressGzip } = require('node:zlib/iter');\n\nasync function run() {\n  const compressed = await bytes(pull(from('hello'), compressGzip()));\n  const original = await text(pull(from(compressed), decompressGzip()));\n  console.log(original); // 'hello'\n}\n\nrun().catch(console.error);\n</code></pre>\n<pre><code class=\"language-mjs\">import { fromSync, pullSync, textSync } from 'node:stream/iter';\nimport { compressGzipSync, decompressGzipSync } from 'node:zlib/iter';\n\n// Sync round-trip\nconst compressed = pullSync(fromSync('hello'), compressGzipSync());\nconst original = textSync(pullSync(compressed, decompressGzipSync()));\nconsole.log(original); // 'hello'\n</code></pre>\n<pre><code class=\"language-cjs\">const { fromSync, pullSync, textSync } = require('node:stream/iter');\nconst { compressGzipSync, decompressGzipSync } = require('node:zlib/iter');\n\nconst compressed = pullSync(fromSync('hello'), compressGzipSync());\nconst original = textSync(pullSync(compressed, decompressGzipSync()));\nconsole.log(original); // 'hello'\n</code></pre>",
          "methods": [
            {
              "textRaw": "`compressBrotli([options])`",
              "name": "compressBrotli",
              "type": "method",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "`compressBrotliSync([options])`",
              "name": "compressBrotliSync",
              "type": "method",
              "meta": {
                "added": [
                  "v25.9.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`options` {Object}",
                      "name": "options",
                      "type": "Object",
                      "options": [
                        {
                          "textRaw": "`chunkSize` {number} Output buffer size. **Default:** `65536` (64 KB).",
                          "name": "chunkSize",
                          "type": "number",
                          "default": "`65536` (64 KB)",
                          "desc": "Output buffer size."
                        },
                        {
                          "textRaw": "`params` {Object} Key-value object where keys and values are `zlib.constants` entries. The most important compressor parameters are:",
                          "name": "params",
                          "type": "Object",
                          "desc": "Key-value object where keys and values are `zlib.constants` entries. The most important compressor parameters are:",
                          "options": [
                            {
                              "textRaw": "`BROTLI_PARAM_MODE` -- `BROTLI_MODE_GENERIC` (default), `BROTLI_MODE_TEXT`, or `BROTLI_MODE_FONT`.",
                              "name": "BROTLI_PARAM_MODE",
                              "desc": "- `BROTLI_MODE_GENERIC` (default), `BROTLI_MODE_TEXT`, or `BROTLI_MODE_FONT`."
                            },
                            {
                              "textRaw": "`BROTLI_PARAM_QUALITY` -- ranges from `BROTLI_MIN_QUALITY` to `BROTLI_MAX_QUALITY`. **Default:** `6` (not `BROTLI_DEFAULT_QUALITY` which is 11). Quality 6 is appropriate for streaming; quality 11 is intended for offline/build-time compression.",
                              "name": "BROTLI_PARAM_QUALITY",
                              "default": "`6` (not `BROTLI_DEFAULT_QUALITY` which is 11). Quality 6 is appropriate for streaming; quality 11 is intended for offline/build-time compression",
                              "desc": "- ranges from `BROTLI_MIN_QUALITY` to `BROTLI_MAX_QUALITY`."
                            },
                            {
                              "textRaw": "`BROTLI_PARAM_SIZE_HINT` -- expected input size. **Default:** `0` (unknown).",
                              "name": "BROTLI_PARAM_SIZE_HINT",
                              "default": "`0` (unknown)",
                              "desc": "- expected input size."
                            },
                            {
                              "textRaw": "`BROTLI_PARAM_LGWIN` -- window size (log2). **Default:** `20` (1 MB). The Brotli library default is 22 (4 MB); the reduced default saves memory without significant compression impact for streaming workloads.",
                              "name": "BROTLI_PARAM_LGWIN",
                              "default": "`20` (1 MB). The Brotli library default is 22 (4 MB); the reduced default saves memory without significant compression impact for streaming workloads",
                              "desc": "- window size (log2)."
                            },
                            {
                              "textRaw": "`BROTLI_PARAM_LGBLOCK` -- input block size (log2). See the Brotli compressor options in the zlib documentation for the full list.",
                              "name": "BROTLI_PARAM_LGBLOCK",
                              "desc": "- input block size (log2). See the Brotli compressor options in the zlib documentation for the full list."
                            }
                          ]
                        },
                        {
                          "textRaw": "`dictionary` {Buffer|TypedArray|DataView}",
                          "name": "dictionary",
                          "type": "Buffer|TypedArray|DataView"
                        }
                      ],
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Object} A stateful transform.",
                    "name": "return",
                    "type": "Object",
                    "desc": "A stateful transform."
                  }
                }
              ],
              "desc": "<p>Create a Brotli compression transform. Output is compatible with\n<code>zlib.brotliDecompress()</code> and <code>decompressBrotli()</code>/<code>decompressBrotliSync()</code>.</p>"
            },
            {
              "textRaw": "`compressDeflate([options])`",
              "name": "compressDeflate",
              "type": "method",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "`compressDeflateSync([options])`",
              "name": "compressDeflateSync",
              "type": "method",
              "meta": {
                "added": [
                  "v25.9.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`options` {Object}",
                      "name": "options",
                      "type": "Object",
                      "options": [
                        {
                          "textRaw": "`chunkSize` {number} Output buffer size. **Default:** `65536` (64 KB).",
                          "name": "chunkSize",
                          "type": "number",
                          "default": "`65536` (64 KB)",
                          "desc": "Output buffer size."
                        },
                        {
                          "textRaw": "`level` {number} Compression level (`0`-`9`). **Default:** `4`.",
                          "name": "level",
                          "type": "number",
                          "default": "`4`",
                          "desc": "Compression level (`0`-`9`)."
                        },
                        {
                          "textRaw": "`windowBits` {number} **Default:** `Z_DEFAULT_WINDOWBITS` (15).",
                          "name": "windowBits",
                          "type": "number",
                          "default": "`Z_DEFAULT_WINDOWBITS` (15)"
                        },
                        {
                          "textRaw": "`memLevel` {number} **Default:** `9`.",
                          "name": "memLevel",
                          "type": "number",
                          "default": "`9`"
                        },
                        {
                          "textRaw": "`strategy` {number} **Default:** `Z_DEFAULT_STRATEGY`.",
                          "name": "strategy",
                          "type": "number",
                          "default": "`Z_DEFAULT_STRATEGY`"
                        },
                        {
                          "textRaw": "`dictionary` {Buffer|TypedArray|DataView}",
                          "name": "dictionary",
                          "type": "Buffer|TypedArray|DataView"
                        }
                      ],
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Object} A stateful transform.",
                    "name": "return",
                    "type": "Object",
                    "desc": "A stateful transform."
                  }
                }
              ],
              "desc": "<p>Create a deflate compression transform. Output is compatible with\n<code>zlib.inflate()</code> and <code>decompressDeflate()</code>/<code>decompressDeflateSync()</code>.</p>"
            },
            {
              "textRaw": "`compressGzip([options])`",
              "name": "compressGzip",
              "type": "method",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "`compressGzipSync([options])`",
              "name": "compressGzipSync",
              "type": "method",
              "meta": {
                "added": [
                  "v25.9.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`options` {Object}",
                      "name": "options",
                      "type": "Object",
                      "options": [
                        {
                          "textRaw": "`chunkSize` {number} Output buffer size. **Default:** `65536` (64 KB).",
                          "name": "chunkSize",
                          "type": "number",
                          "default": "`65536` (64 KB)",
                          "desc": "Output buffer size."
                        },
                        {
                          "textRaw": "`level` {number} Compression level (`0`-`9`). **Default:** `4`.",
                          "name": "level",
                          "type": "number",
                          "default": "`4`",
                          "desc": "Compression level (`0`-`9`)."
                        },
                        {
                          "textRaw": "`windowBits` {number} **Default:** `Z_DEFAULT_WINDOWBITS` (15).",
                          "name": "windowBits",
                          "type": "number",
                          "default": "`Z_DEFAULT_WINDOWBITS` (15)"
                        },
                        {
                          "textRaw": "`memLevel` {number} **Default:** `9`.",
                          "name": "memLevel",
                          "type": "number",
                          "default": "`9`"
                        },
                        {
                          "textRaw": "`strategy` {number} **Default:** `Z_DEFAULT_STRATEGY`.",
                          "name": "strategy",
                          "type": "number",
                          "default": "`Z_DEFAULT_STRATEGY`"
                        },
                        {
                          "textRaw": "`dictionary` {Buffer|TypedArray|DataView}",
                          "name": "dictionary",
                          "type": "Buffer|TypedArray|DataView"
                        }
                      ],
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Object} A stateful transform.",
                    "name": "return",
                    "type": "Object",
                    "desc": "A stateful transform."
                  }
                }
              ],
              "desc": "<p>Create a gzip compression transform. Output is compatible with <code>zlib.gunzip()</code>\nand <code>decompressGzip()</code>/<code>decompressGzipSync()</code>.</p>"
            },
            {
              "textRaw": "`compressZstd([options])`",
              "name": "compressZstd",
              "type": "method",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "`compressZstdSync([options])`",
              "name": "compressZstdSync",
              "type": "method",
              "meta": {
                "added": [
                  "v25.9.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`options` {Object}",
                      "name": "options",
                      "type": "Object",
                      "options": [
                        {
                          "textRaw": "`chunkSize` {number} Output buffer size. **Default:** `65536` (64 KB).",
                          "name": "chunkSize",
                          "type": "number",
                          "default": "`65536` (64 KB)",
                          "desc": "Output buffer size."
                        },
                        {
                          "textRaw": "`params` {Object} Key-value object where keys and values are `zlib.constants` entries. The most important compressor parameters are:",
                          "name": "params",
                          "type": "Object",
                          "desc": "Key-value object where keys and values are `zlib.constants` entries. The most important compressor parameters are:",
                          "options": [
                            {
                              "textRaw": "`ZSTD_c_compressionLevel` -- **Default:** `ZSTD_CLEVEL_DEFAULT` (3).",
                              "name": "ZSTD_c_compressionLevel",
                              "default": "`ZSTD_CLEVEL_DEFAULT` (3)",
                              "desc": "-"
                            },
                            {
                              "textRaw": "`ZSTD_c_checksumFlag` -- generate a checksum. **Default:** `0`.",
                              "name": "ZSTD_c_checksumFlag",
                              "default": "`0`",
                              "desc": "- generate a checksum."
                            },
                            {
                              "textRaw": "`ZSTD_c_strategy` -- compression strategy. Values include `ZSTD_fast`, `ZSTD_dfast`, `ZSTD_greedy`, `ZSTD_lazy`, `ZSTD_lazy2`, `ZSTD_btlazy2`, `ZSTD_btopt`, `ZSTD_btultra`, `ZSTD_btultra2`. See the Zstd compressor options in the zlib documentation for the full list.",
                              "name": "ZSTD_c_strategy",
                              "desc": "- compression strategy. Values include `ZSTD_fast`, `ZSTD_dfast`, `ZSTD_greedy`, `ZSTD_lazy`, `ZSTD_lazy2`, `ZSTD_btlazy2`, `ZSTD_btopt`, `ZSTD_btultra`, `ZSTD_btultra2`. See the Zstd compressor options in the zlib documentation for the full list."
                            }
                          ]
                        },
                        {
                          "textRaw": "`pledgedSrcSize` {number} Expected uncompressed size as a non-negative safe integer (optional hint).",
                          "name": "pledgedSrcSize",
                          "type": "number",
                          "desc": "Expected uncompressed size as a non-negative safe integer (optional hint)."
                        },
                        {
                          "textRaw": "`dictionary` {Buffer|TypedArray|DataView}",
                          "name": "dictionary",
                          "type": "Buffer|TypedArray|DataView"
                        }
                      ],
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Object} A stateful transform.",
                    "name": "return",
                    "type": "Object",
                    "desc": "A stateful transform."
                  }
                }
              ],
              "desc": "<p>Create a Zstandard compression transform. Output is compatible with\n<code>zlib.zstdDecompress()</code> and <code>decompressZstd()</code>/<code>decompressZstdSync()</code>.</p>"
            },
            {
              "textRaw": "`decompressBrotli([options])`",
              "name": "decompressBrotli",
              "type": "method",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "`decompressBrotliSync([options])`",
              "name": "decompressBrotliSync",
              "type": "method",
              "meta": {
                "added": [
                  "v25.9.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`options` {Object}",
                      "name": "options",
                      "type": "Object",
                      "options": [
                        {
                          "textRaw": "`chunkSize` {number} Output buffer size. **Default:** `65536` (64 KB).",
                          "name": "chunkSize",
                          "type": "number",
                          "default": "`65536` (64 KB)",
                          "desc": "Output buffer size."
                        },
                        {
                          "textRaw": "`params` {Object} Key-value object where keys and values are `zlib.constants` entries. Available decompressor parameters:",
                          "name": "params",
                          "type": "Object",
                          "desc": "Key-value object where keys and values are `zlib.constants` entries. Available decompressor parameters:",
                          "options": [
                            {
                              "textRaw": "`BROTLI_DECODER_PARAM_DISABLE_RING_BUFFER_REALLOCATION` -- boolean flag affecting internal memory allocation.",
                              "name": "BROTLI_DECODER_PARAM_DISABLE_RING_BUFFER_REALLOCATION",
                              "desc": "- boolean flag affecting internal memory allocation."
                            },
                            {
                              "textRaw": "`BROTLI_DECODER_PARAM_LARGE_WINDOW` -- boolean flag enabling \"Large Window Brotli\" mode (not compatible with RFC 7932). See the Brotli decompressor options in the zlib documentation for details.",
                              "name": "BROTLI_DECODER_PARAM_LARGE_WINDOW",
                              "desc": "- boolean flag enabling \"Large Window Brotli\" mode (not compatible with RFC 7932). See the Brotli decompressor options in the zlib documentation for details."
                            }
                          ]
                        },
                        {
                          "textRaw": "`dictionary` {Buffer|TypedArray|DataView}",
                          "name": "dictionary",
                          "type": "Buffer|TypedArray|DataView"
                        }
                      ],
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Object} A stateful transform.",
                    "name": "return",
                    "type": "Object",
                    "desc": "A stateful transform."
                  }
                }
              ],
              "desc": "<p>Create a Brotli decompression transform.</p>"
            },
            {
              "textRaw": "`decompressDeflate([options])`",
              "name": "decompressDeflate",
              "type": "method",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "`decompressDeflateSync([options])`",
              "name": "decompressDeflateSync",
              "type": "method",
              "meta": {
                "added": [
                  "v25.9.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`options` {Object}",
                      "name": "options",
                      "type": "Object",
                      "options": [
                        {
                          "textRaw": "`chunkSize` {number} Output buffer size. **Default:** `65536` (64 KB).",
                          "name": "chunkSize",
                          "type": "number",
                          "default": "`65536` (64 KB)",
                          "desc": "Output buffer size."
                        },
                        {
                          "textRaw": "`windowBits` {number} **Default:** `Z_DEFAULT_WINDOWBITS` (15).",
                          "name": "windowBits",
                          "type": "number",
                          "default": "`Z_DEFAULT_WINDOWBITS` (15)"
                        },
                        {
                          "textRaw": "`dictionary` {Buffer|TypedArray|DataView}",
                          "name": "dictionary",
                          "type": "Buffer|TypedArray|DataView"
                        }
                      ],
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Object} A stateful transform.",
                    "name": "return",
                    "type": "Object",
                    "desc": "A stateful transform."
                  }
                }
              ],
              "desc": "<p>Create a deflate decompression transform.</p>"
            },
            {
              "textRaw": "`decompressGzip([options])`",
              "name": "decompressGzip",
              "type": "method",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "`decompressGzipSync([options])`",
              "name": "decompressGzipSync",
              "type": "method",
              "meta": {
                "added": [
                  "v25.9.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`options` {Object}",
                      "name": "options",
                      "type": "Object",
                      "options": [
                        {
                          "textRaw": "`chunkSize` {number} Output buffer size. **Default:** `65536` (64 KB).",
                          "name": "chunkSize",
                          "type": "number",
                          "default": "`65536` (64 KB)",
                          "desc": "Output buffer size."
                        },
                        {
                          "textRaw": "`windowBits` {number} **Default:** `Z_DEFAULT_WINDOWBITS` (15).",
                          "name": "windowBits",
                          "type": "number",
                          "default": "`Z_DEFAULT_WINDOWBITS` (15)"
                        },
                        {
                          "textRaw": "`dictionary` {Buffer|TypedArray|DataView}",
                          "name": "dictionary",
                          "type": "Buffer|TypedArray|DataView"
                        }
                      ],
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Object} A stateful transform.",
                    "name": "return",
                    "type": "Object",
                    "desc": "A stateful transform."
                  }
                }
              ],
              "desc": "<p>Create a gzip decompression transform.</p>"
            },
            {
              "textRaw": "`decompressZstd([options])`",
              "name": "decompressZstd",
              "type": "method",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "`decompressZstdSync([options])`",
              "name": "decompressZstdSync",
              "type": "method",
              "meta": {
                "added": [
                  "v25.9.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`options` {Object}",
                      "name": "options",
                      "type": "Object",
                      "options": [
                        {
                          "textRaw": "`chunkSize` {number} Output buffer size. **Default:** `65536` (64 KB).",
                          "name": "chunkSize",
                          "type": "number",
                          "default": "`65536` (64 KB)",
                          "desc": "Output buffer size."
                        },
                        {
                          "textRaw": "`params` {Object} Key-value object where keys and values are `zlib.constants` entries. Available decompressor parameters:",
                          "name": "params",
                          "type": "Object",
                          "desc": "Key-value object where keys and values are `zlib.constants` entries. Available decompressor parameters:",
                          "options": [
                            {
                              "textRaw": "`ZSTD_d_windowLogMax` -- maximum window size (log2) the decompressor will allocate. Limits memory usage against malicious input. See the Zstd decompressor options in the zlib documentation for details.",
                              "name": "ZSTD_d_windowLogMax",
                              "desc": "- maximum window size (log2) the decompressor will allocate. Limits memory usage against malicious input. See the Zstd decompressor options in the zlib documentation for details."
                            }
                          ]
                        },
                        {
                          "textRaw": "`dictionary` {Buffer|TypedArray|DataView}",
                          "name": "dictionary",
                          "type": "Buffer|TypedArray|DataView"
                        }
                      ],
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Object} A stateful transform.",
                    "name": "return",
                    "type": "Object",
                    "desc": "A stateful transform."
                  }
                }
              ],
              "desc": "<p>Create a Zstandard decompression transform.</p>"
            }
          ],
          "displayName": "Iterable Compression"
        }
      ],
      "miscs": [
        {
          "textRaw": "Memory usage tuning",
          "name": "Memory usage tuning",
          "type": "misc",
          "miscs": [
            {
              "textRaw": "For zlib-based streams",
              "name": "for_zlib-based_streams",
              "type": "misc",
              "desc": "<p>From <code>zlib/zconf.h</code>, modified for Node.js usage:</p>\n<p>The memory requirements for deflate are (in bytes):</p>\n<pre><code class=\"language-js\">(1 &#x3C;&#x3C; (windowBits + 2)) + (1 &#x3C;&#x3C; (memLevel + 9));\n</code></pre>\n<p>That is: 128K for <code>windowBits</code> = 15 + 128K for <code>memLevel</code> = 8\n(default values) plus a few kilobytes for small objects.</p>\n<p>For example, to reduce the default memory requirements from 256K to 128K, the\noptions should be set to:</p>\n<pre><code class=\"language-js\">const options = { windowBits: 14, memLevel: 7 };\n</code></pre>\n<p>This will, however, generally degrade compression.</p>\n<p>The memory requirements for inflate are (in bytes) <code>1 &#x3C;&#x3C; windowBits</code>.\nThat is, 32K for <code>windowBits</code> = 15 (default value) plus a few kilobytes\nfor small objects.</p>\n<p>This is in addition to a single internal output slab buffer of size\n<code>chunkSize</code>, which defaults to 16K.</p>\n<p>The speed of <code>zlib</code> compression is affected most dramatically by the\n<code>level</code> setting. A higher level will result in better compression, but\nwill take longer to complete. A lower level will result in less\ncompression, but will be much faster.</p>\n<p>In general, greater memory usage options will mean that Node.js has to make\nfewer calls to <code>zlib</code> because it will be able to process more data on\neach <code>write</code> operation. So, this is another factor that affects the\nspeed, at the cost of memory usage.</p>",
              "displayName": "For zlib-based streams"
            },
            {
              "textRaw": "For Brotli-based streams",
              "name": "for_brotli-based_streams",
              "type": "misc",
              "desc": "<p>There are equivalents to the zlib options for Brotli-based streams, although\nthese options have different ranges than the zlib ones:</p>\n<ul>\n<li>zlib's <code>level</code> option matches Brotli's <code>BROTLI_PARAM_QUALITY</code> option.</li>\n<li>zlib's <code>windowBits</code> option matches Brotli's <code>BROTLI_PARAM_LGWIN</code> option.</li>\n</ul>\n<p>See <a href=\"#brotli-constants\">below</a> for more details on Brotli-specific options.</p>",
              "displayName": "For Brotli-based streams"
            },
            {
              "textRaw": "For Zstd-based streams",
              "name": "for_zstd-based_streams",
              "type": "misc",
              "stability": 1,
              "stabilityText": "Experimental",
              "desc": "<p>There are equivalents to the zlib options for Zstd-based streams, although\nthese options have different ranges than the zlib ones:</p>\n<ul>\n<li>zlib's <code>level</code> option matches Zstd's <code>ZSTD_c_compressionLevel</code> option.</li>\n<li>zlib's <code>windowBits</code> option matches Zstd's <code>ZSTD_c_windowLog</code> option.</li>\n</ul>\n<p>See <a href=\"#zstd-constants\">below</a> for more details on Zstd-specific options.</p>",
              "displayName": "For Zstd-based streams"
            }
          ]
        },
        {
          "textRaw": "Constants",
          "name": "Constants",
          "type": "misc",
          "meta": {
            "added": [
              "v0.5.8"
            ],
            "changes": []
          },
          "miscs": [
            {
              "textRaw": "zlib constants",
              "name": "zlib_constants",
              "type": "misc",
              "desc": "<p>All of the constants defined in <code>zlib.h</code> are also defined on\n<code>require('node:zlib').constants</code>. In the normal course of operations, it will\nnot be necessary to use these constants. They are documented so that their\npresence is not surprising. This section is taken almost directly from the\n<a href=\"https://zlib.net/manual.html#Constants\">zlib documentation</a>.</p>\n<p>Previously, the constants were available directly from <code>require('node:zlib')</code>,\nfor instance <code>zlib.Z_NO_FLUSH</code>. Accessing the constants directly from the module\nis currently still possible but is deprecated.</p>\n<p>Allowed flush values.</p>\n<ul>\n<li><code>zlib.constants.Z_NO_FLUSH</code></li>\n<li><code>zlib.constants.Z_PARTIAL_FLUSH</code></li>\n<li><code>zlib.constants.Z_SYNC_FLUSH</code></li>\n<li><code>zlib.constants.Z_FULL_FLUSH</code></li>\n<li><code>zlib.constants.Z_FINISH</code></li>\n<li><code>zlib.constants.Z_BLOCK</code></li>\n</ul>\n<p>Return codes for the compression/decompression functions. Negative\nvalues are errors, positive values are used for special but normal\nevents.</p>\n<ul>\n<li><code>zlib.constants.Z_OK</code></li>\n<li><code>zlib.constants.Z_STREAM_END</code></li>\n<li><code>zlib.constants.Z_NEED_DICT</code></li>\n<li><code>zlib.constants.Z_ERRNO</code></li>\n<li><code>zlib.constants.Z_STREAM_ERROR</code></li>\n<li><code>zlib.constants.Z_DATA_ERROR</code></li>\n<li><code>zlib.constants.Z_MEM_ERROR</code></li>\n<li><code>zlib.constants.Z_BUF_ERROR</code></li>\n<li><code>zlib.constants.Z_VERSION_ERROR</code></li>\n</ul>\n<p>Compression levels.</p>\n<ul>\n<li><code>zlib.constants.Z_NO_COMPRESSION</code></li>\n<li><code>zlib.constants.Z_BEST_SPEED</code></li>\n<li><code>zlib.constants.Z_BEST_COMPRESSION</code></li>\n<li><code>zlib.constants.Z_DEFAULT_COMPRESSION</code></li>\n</ul>\n<p>Compression strategy.</p>\n<ul>\n<li><code>zlib.constants.Z_FILTERED</code></li>\n<li><code>zlib.constants.Z_HUFFMAN_ONLY</code></li>\n<li><code>zlib.constants.Z_RLE</code></li>\n<li><code>zlib.constants.Z_FIXED</code></li>\n<li><code>zlib.constants.Z_DEFAULT_STRATEGY</code></li>\n</ul>",
              "displayName": "zlib constants"
            },
            {
              "textRaw": "Brotli constants",
              "name": "brotli_constants",
              "type": "misc",
              "meta": {
                "added": [
                  "v11.7.0",
                  "v10.16.0"
                ],
                "changes": []
              },
              "desc": "<p>There are several options and other constants available for Brotli-based\nstreams:</p>",
              "modules": [
                {
                  "textRaw": "Flush operations",
                  "name": "flush_operations",
                  "type": "module",
                  "desc": "<p>The following values are valid flush operations for Brotli-based streams:</p>\n<ul>\n<li><code>zlib.constants.BROTLI_OPERATION_PROCESS</code> (default for all operations)</li>\n<li><code>zlib.constants.BROTLI_OPERATION_FLUSH</code> (default when calling <code>.flush()</code>)</li>\n<li><code>zlib.constants.BROTLI_OPERATION_FINISH</code> (default for the last chunk)</li>\n<li><code>zlib.constants.BROTLI_OPERATION_EMIT_METADATA</code>\n<ul>\n<li>This particular operation may be hard to use in a Node.js context,\nas the streaming layer makes it hard to know which data will end up\nin this frame. Also, there is currently no way to consume this data through\nthe Node.js API.</li>\n</ul>\n</li>\n</ul>",
                  "displayName": "Flush operations"
                },
                {
                  "textRaw": "Compressor options",
                  "name": "compressor_options",
                  "type": "module",
                  "desc": "<p>There are several options that can be set on Brotli encoders, affecting\ncompression efficiency and speed. Both the keys and the values can be accessed\nas properties of the <code>zlib.constants</code> object.</p>\n<p>The most important options are:</p>\n<ul>\n<li><code>BROTLI_PARAM_MODE</code>\n<ul>\n<li><code>BROTLI_MODE_GENERIC</code> (default)</li>\n<li><code>BROTLI_MODE_TEXT</code>, adjusted for UTF-8 text</li>\n<li><code>BROTLI_MODE_FONT</code>, adjusted for WOFF 2.0 fonts</li>\n</ul>\n</li>\n<li><code>BROTLI_PARAM_QUALITY</code>\n<ul>\n<li>Ranges from <code>BROTLI_MIN_QUALITY</code> to <code>BROTLI_MAX_QUALITY</code>,\nwith a default of <code>BROTLI_DEFAULT_QUALITY</code>.</li>\n</ul>\n</li>\n<li><code>BROTLI_PARAM_SIZE_HINT</code>\n<ul>\n<li>Integer value representing the expected input size;\ndefaults to <code>0</code> for an unknown input size.</li>\n</ul>\n</li>\n</ul>\n<p>The following flags can be set for advanced control over the compression\nalgorithm and memory usage tuning:</p>\n<ul>\n<li><code>BROTLI_PARAM_LGWIN</code>\n<ul>\n<li>Ranges from <code>BROTLI_MIN_WINDOW_BITS</code> to <code>BROTLI_MAX_WINDOW_BITS</code>,\nwith a default of <code>BROTLI_DEFAULT_WINDOW</code>, or up to\n<code>BROTLI_LARGE_MAX_WINDOW_BITS</code> if the <code>BROTLI_PARAM_LARGE_WINDOW</code> flag\nis set.</li>\n</ul>\n</li>\n<li><code>BROTLI_PARAM_LGBLOCK</code>\n<ul>\n<li>Ranges from <code>BROTLI_MIN_INPUT_BLOCK_BITS</code> to <code>BROTLI_MAX_INPUT_BLOCK_BITS</code>.</li>\n</ul>\n</li>\n<li><code>BROTLI_PARAM_DISABLE_LITERAL_CONTEXT_MODELING</code>\n<ul>\n<li>Boolean flag that decreases compression ratio in favour of\ndecompression speed.</li>\n</ul>\n</li>\n<li><code>BROTLI_PARAM_LARGE_WINDOW</code>\n<ul>\n<li>Boolean flag enabling “Large Window Brotli” mode (not compatible with the\nBrotli format as standardized in <a href=\"https://www.rfc-editor.org/rfc/rfc7932.html\">RFC 7932</a>).</li>\n</ul>\n</li>\n<li><code>BROTLI_PARAM_NPOSTFIX</code>\n<ul>\n<li>Ranges from <code>0</code> to <code>BROTLI_MAX_NPOSTFIX</code>.</li>\n</ul>\n</li>\n<li><code>BROTLI_PARAM_NDIRECT</code>\n<ul>\n<li>Ranges from <code>0</code> to <code>15 &#x3C;&#x3C; NPOSTFIX</code> in steps of <code>1 &#x3C;&#x3C; NPOSTFIX</code>.</li>\n</ul>\n</li>\n</ul>",
                  "displayName": "Compressor options"
                },
                {
                  "textRaw": "Decompressor options",
                  "name": "decompressor_options",
                  "type": "module",
                  "desc": "<p>These advanced options are available for controlling decompression:</p>\n<ul>\n<li><code>BROTLI_DECODER_PARAM_DISABLE_RING_BUFFER_REALLOCATION</code>\n<ul>\n<li>Boolean flag that affects internal memory allocation patterns.</li>\n</ul>\n</li>\n<li><code>BROTLI_DECODER_PARAM_LARGE_WINDOW</code>\n<ul>\n<li>Boolean flag enabling “Large Window Brotli” mode (not compatible with the\nBrotli format as standardized in <a href=\"https://www.rfc-editor.org/rfc/rfc7932.html\">RFC 7932</a>).</li>\n</ul>\n</li>\n</ul>",
                  "displayName": "Decompressor options"
                }
              ],
              "displayName": "Brotli constants"
            },
            {
              "textRaw": "Zstd constants",
              "name": "zstd_constants",
              "type": "misc",
              "meta": {
                "added": [
                  "v23.8.0",
                  "v22.15.0"
                ],
                "changes": []
              },
              "stability": 1,
              "stabilityText": "Experimental",
              "desc": "<p>There are several options and other constants available for Zstd-based\nstreams:</p>",
              "modules": [
                {
                  "textRaw": "Flush operations",
                  "name": "flush_operations",
                  "type": "module",
                  "desc": "<p>The following values are valid flush operations for Zstd-based streams:</p>\n<ul>\n<li><code>zlib.constants.ZSTD_e_continue</code> (default for all operations)</li>\n<li><code>zlib.constants.ZSTD_e_flush</code> (default when calling <code>.flush()</code>)</li>\n<li><code>zlib.constants.ZSTD_e_end</code> (default for the last chunk)</li>\n</ul>",
                  "displayName": "Flush operations"
                },
                {
                  "textRaw": "Compressor options",
                  "name": "compressor_options",
                  "type": "module",
                  "desc": "<p>There are several options that can be set on Zstd encoders, affecting\ncompression efficiency and speed. Both the keys and the values can be accessed\nas properties of the <code>zlib.constants</code> object.</p>\n<p>The most important options are:</p>\n<ul>\n<li><code>ZSTD_c_compressionLevel</code>\n<ul>\n<li>Set compression parameters according to pre-defined cLevel table. Default\nlevel is ZSTD_CLEVEL_DEFAULT==3.</li>\n</ul>\n</li>\n<li><code>ZSTD_c_strategy</code>\n<ul>\n<li>Select the compression strategy.</li>\n<li>Possible values are listed in the strategy options section below.</li>\n</ul>\n</li>\n</ul>",
                  "displayName": "Compressor options"
                },
                {
                  "textRaw": "Strategy options",
                  "name": "strategy_options",
                  "type": "module",
                  "desc": "<p>The following constants can be used as values for the <code>ZSTD_c_strategy</code>\nparameter:</p>\n<ul>\n<li><code>zlib.constants.ZSTD_fast</code></li>\n<li><code>zlib.constants.ZSTD_dfast</code></li>\n<li><code>zlib.constants.ZSTD_greedy</code></li>\n<li><code>zlib.constants.ZSTD_lazy</code></li>\n<li><code>zlib.constants.ZSTD_lazy2</code></li>\n<li><code>zlib.constants.ZSTD_btlazy2</code></li>\n<li><code>zlib.constants.ZSTD_btopt</code></li>\n<li><code>zlib.constants.ZSTD_btultra</code></li>\n<li><code>zlib.constants.ZSTD_btultra2</code></li>\n</ul>\n<p>Example:</p>\n<pre><code class=\"language-js\">const stream = zlib.createZstdCompress({\n  params: {\n    [zlib.constants.ZSTD_c_strategy]: zlib.constants.ZSTD_btultra,\n  },\n});\n</code></pre>",
                  "displayName": "Strategy options"
                },
                {
                  "textRaw": "Pledged Source Size",
                  "name": "pledged_source_size",
                  "type": "module",
                  "desc": "<p>It's possible to specify the expected total size of the uncompressed input via\n<code>opts.pledgedSrcSize</code>, which must be a non-negative safe integer. If the size\ndoesn't match at the end of the input, compression will fail with the code\n<code>ZSTD_error_srcSize_wrong</code>.</p>",
                  "displayName": "Pledged Source Size"
                },
                {
                  "textRaw": "Decompressor options",
                  "name": "decompressor_options",
                  "type": "module",
                  "desc": "<p>These advanced options are available for controlling decompression:</p>\n<ul>\n<li><code>ZSTD_d_windowLogMax</code>\n<ul>\n<li>Select a size limit (in power of 2) beyond which the streaming API will\nrefuse to allocate memory buffer in order to protect the host from\nunreasonable memory requirements.</li>\n</ul>\n</li>\n</ul>",
                  "displayName": "Decompressor options"
                }
              ],
              "displayName": "Zstd constants"
            }
          ]
        },
        {
          "textRaw": "Class: `Options`",
          "name": "Options",
          "type": "misc",
          "meta": {
            "added": [
              "v0.11.1"
            ],
            "changes": [
              {
                "version": "v26.5.0",
                "pr-url": "https://github.com/nodejs/node/pull/64023",
                "description": "The `rejectGarbageAfterEnd` option was added."
              },
              {
                "version": [
                  "v14.5.0",
                  "v12.19.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/33516",
                "description": "The `maxOutputLength` option is supported now."
              },
              {
                "version": "v9.4.0",
                "pr-url": "https://github.com/nodejs/node/pull/16042",
                "description": "The `dictionary` option can be an `ArrayBuffer`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12001",
                "description": "The `dictionary` option can be an `Uint8Array` now."
              },
              {
                "version": "v5.11.0",
                "pr-url": "https://github.com/nodejs/node/pull/6069",
                "description": "The `finishFlush` option is supported now."
              }
            ]
          },
          "desc": "<p>Each zlib-based class takes an <code>options</code> object. No options are required.</p>\n<p>Some options are only relevant when compressing and are\nignored by the decompression classes.</p>\n<ul>\n<li><code>flush</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#number_type\"><code>&#x3C;integer></code></a> <strong>Default:</strong> <code>zlib.constants.Z_NO_FLUSH</code></li>\n<li><code>finishFlush</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#number_type\"><code>&#x3C;integer></code></a> <strong>Default:</strong> <code>zlib.constants.Z_FINISH</code></li>\n<li><code>chunkSize</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#number_type\"><code>&#x3C;integer></code></a> <strong>Default:</strong> <code>16 * 1024</code></li>\n<li><code>windowBits</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#number_type\"><code>&#x3C;integer></code></a></li>\n<li><code>level</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#number_type\"><code>&#x3C;integer></code></a> (compression only)</li>\n<li><code>memLevel</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#number_type\"><code>&#x3C;integer></code></a> (compression only)</li>\n<li><code>strategy</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#number_type\"><code>&#x3C;integer></code></a> (compression only)</li>\n<li><code>dictionary</code> <a href=\"buffer.html#class-buffer\"><code>&#x3C;Buffer></code></a> | <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\"><code>&#x3C;TypedArray></code></a> | <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/DataView\"><code>&#x3C;DataView></code></a> | <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\"><code>&#x3C;ArrayBuffer></code></a> (deflate/inflate only,\nempty dictionary by default)</li>\n<li><code>info</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#boolean_type\"><code>&#x3C;boolean></code></a> (If <code>true</code>, returns an object with <code>buffer</code> and <code>engine</code>.)</li>\n<li><code>maxOutputLength</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#number_type\"><code>&#x3C;integer></code></a> Limits output size when using <a href=\"#convenience-methods\">convenience methods</a>. <strong>Default:</strong> <a href=\"buffer.html#bufferkmaxlength\"><code>buffer.kMaxLength</code></a></li>\n<li><code>rejectGarbageAfterEnd</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#boolean_type\"><code>&#x3C;boolean></code></a> If <code>true</code>, decompression fails when\ntrailing input is detected after the end of the compressed stream. This\nincludes unreadable bytes and, when decompressing gzip, additional gzip\nmembers following the first member. <strong>Default:</strong> <code>false</code></li>\n</ul>\n<p>See the <a href=\"https://zlib.net/manual.html#Advanced\"><code>deflateInit2</code> and <code>inflateInit2</code></a> documentation for more\ninformation.</p>"
        },
        {
          "textRaw": "Class: `BrotliOptions`",
          "name": "BrotliOptions",
          "type": "misc",
          "meta": {
            "added": [
              "v11.7.0"
            ],
            "changes": [
              {
                "version": "v26.5.0",
                "pr-url": "https://github.com/nodejs/node/pull/64023",
                "description": "The `rejectGarbageAfterEnd` option was added."
              },
              {
                "version": [
                  "v14.5.0",
                  "v12.19.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/33516",
                "description": "The `maxOutputLength` option is supported now."
              }
            ]
          },
          "desc": "<p>Each Brotli-based class takes an <code>options</code> object. All options are optional.</p>\n<ul>\n<li><code>flush</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#number_type\"><code>&#x3C;integer></code></a> <strong>Default:</strong> <code>zlib.constants.BROTLI_OPERATION_PROCESS</code></li>\n<li><code>finishFlush</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#number_type\"><code>&#x3C;integer></code></a> <strong>Default:</strong> <code>zlib.constants.BROTLI_OPERATION_FINISH</code></li>\n<li><code>chunkSize</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#number_type\"><code>&#x3C;integer></code></a> <strong>Default:</strong> <code>16 * 1024</code></li>\n<li><code>params</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object\"><code>&#x3C;Object></code></a> Key-value object containing indexed <a href=\"#brotli-constants\">Brotli parameters</a>.</li>\n<li><code>maxOutputLength</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#number_type\"><code>&#x3C;integer></code></a> Limits output size when using <a href=\"#convenience-methods\">convenience methods</a>. <strong>Default:</strong> <a href=\"buffer.html#bufferkmaxlength\"><code>buffer.kMaxLength</code></a></li>\n<li><code>info</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#boolean_type\"><code>&#x3C;boolean></code></a> If <code>true</code>, returns an object with <code>buffer</code> and <code>engine</code>. <strong>Default:</strong> <code>false</code></li>\n<li><code>rejectGarbageAfterEnd</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#boolean_type\"><code>&#x3C;boolean></code></a> If <code>true</code>, decompression fails when\ninput remains after the first complete compressed stream. <strong>Default:</strong> <code>false</code></li>\n</ul>\n<p>For example:</p>\n<pre><code class=\"language-js\">const stream = zlib.createBrotliCompress({\n  chunkSize: 32 * 1024,\n  params: {\n    [zlib.constants.BROTLI_PARAM_MODE]: zlib.constants.BROTLI_MODE_TEXT,\n    [zlib.constants.BROTLI_PARAM_QUALITY]: 4,\n    [zlib.constants.BROTLI_PARAM_SIZE_HINT]: fs.statSync(inputFile).size,\n  },\n});\n</code></pre>"
        },
        {
          "textRaw": "Class: `ZstdOptions`",
          "name": "ZstdOptions",
          "type": "misc",
          "meta": {
            "added": [
              "v23.8.0",
              "v22.15.0"
            ],
            "changes": [
              {
                "version": "v26.7.0",
                "pr-url": "https://github.com/nodejs/node/pull/64599",
                "description": "The `dictionary` option can be a `TypedArray`, `DataView`, or `ArrayBuffer`."
              },
              {
                "version": "v26.5.0",
                "pr-url": "https://github.com/nodejs/node/pull/64023",
                "description": "The `rejectGarbageAfterEnd` option was added."
              }
            ]
          },
          "stability": 1,
          "stabilityText": "Experimental",
          "desc": "<p>Each Zstd-based class takes an <code>options</code> object. All options are optional.</p>\n<ul>\n<li><code>flush</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#number_type\"><code>&#x3C;integer></code></a> <strong>Default:</strong> <code>zlib.constants.ZSTD_e_continue</code></li>\n<li><code>finishFlush</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#number_type\"><code>&#x3C;integer></code></a> <strong>Default:</strong> <code>zlib.constants.ZSTD_e_end</code></li>\n<li><code>chunkSize</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#number_type\"><code>&#x3C;integer></code></a> <strong>Default:</strong> <code>16 * 1024</code></li>\n<li><code>params</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object\"><code>&#x3C;Object></code></a> Key-value object containing indexed <a href=\"#zstd-constants\">Zstd parameters</a>.</li>\n<li><code>maxOutputLength</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#number_type\"><code>&#x3C;integer></code></a> Limits output size when using <a href=\"#convenience-methods\">convenience methods</a>. <strong>Default:</strong> <a href=\"buffer.html#bufferkmaxlength\"><code>buffer.kMaxLength</code></a></li>\n<li><code>info</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#boolean_type\"><code>&#x3C;boolean></code></a> If <code>true</code>, returns an object with <code>buffer</code> and <code>engine</code>. <strong>Default:</strong> <code>false</code></li>\n<li><code>dictionary</code> <a href=\"buffer.html#class-buffer\"><code>&#x3C;Buffer></code></a> | <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\"><code>&#x3C;TypedArray></code></a> | <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/DataView\"><code>&#x3C;DataView></code></a> | <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\"><code>&#x3C;ArrayBuffer></code></a> Optional dictionary used\nto improve compression efficiency when compressing or decompressing data that\nshares common patterns with the dictionary.</li>\n<li><code>rejectGarbageAfterEnd</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Data_structures#boolean_type\"><code>&#x3C;boolean></code></a> If <code>true</code>, decompression fails when\ninput remains after the first complete compressed stream. <strong>Default:</strong> <code>false</code></li>\n</ul>\n<p>For example:</p>\n<pre><code class=\"language-js\">const stream = zlib.createZstdCompress({\n  chunkSize: 32 * 1024,\n  params: {\n    [zlib.constants.ZSTD_c_compressionLevel]: 10,\n    [zlib.constants.ZSTD_c_checksumFlag]: 1,\n  },\n});\n</code></pre>"
        },
        {
          "textRaw": "Convenience methods",
          "name": "Convenience methods",
          "type": "misc",
          "desc": "<p>All of these take a <a href=\"buffer.html#class-buffer\"><code>&#x3C;Buffer></code></a>, <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\"><code>&#x3C;TypedArray></code></a>, <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/DataView\"><code>&#x3C;DataView></code></a>, <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer\"><code>&#x3C;ArrayBuffer></code></a>, or string\nas the first argument, an optional second argument\nto supply options to the <code>zlib</code> classes and will call the supplied callback\nwith <code>callback(error, result)</code>.</p>\n<p>Every method has a <code>*Sync</code> counterpart, which accept the same arguments, but\nwithout a callback.</p>",
          "methods": [
            {
              "textRaw": "`zlib.brotliCompress(buffer[, options], callback)`",
              "name": "brotliCompress",
              "type": "method",
              "meta": {
                "added": [
                  "v11.7.0",
                  "v10.16.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                      "name": "buffer",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                    },
                    {
                      "textRaw": "`options` {brotli options}",
                      "name": "options",
                      "type": "brotli options",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function}",
                      "name": "callback",
                      "type": "Function"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "`zlib.brotliCompressSync(buffer[, options])`",
              "name": "brotliCompressSync",
              "type": "method",
              "meta": {
                "added": [
                  "v11.7.0",
                  "v10.16.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                      "name": "buffer",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                    },
                    {
                      "textRaw": "`options` {brotli options}",
                      "name": "options",
                      "type": "brotli options",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "<p>Compress a chunk of data with <a href=\"#class-zlibbrotlicompress\"><code>BrotliCompress</code></a>.</p>"
            },
            {
              "textRaw": "`zlib.brotliDecompress(buffer[, options], callback)`",
              "name": "brotliDecompress",
              "type": "method",
              "meta": {
                "added": [
                  "v11.7.0",
                  "v10.16.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                      "name": "buffer",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                    },
                    {
                      "textRaw": "`options` {brotli options}",
                      "name": "options",
                      "type": "brotli options",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function}",
                      "name": "callback",
                      "type": "Function"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "`zlib.brotliDecompressSync(buffer[, options])`",
              "name": "brotliDecompressSync",
              "type": "method",
              "meta": {
                "added": [
                  "v11.7.0",
                  "v10.16.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                      "name": "buffer",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                    },
                    {
                      "textRaw": "`options` {brotli options}",
                      "name": "options",
                      "type": "brotli options",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "<p>Decompress a chunk of data with <a href=\"#class-zlibbrotlidecompress\"><code>BrotliDecompress</code></a>.</p>"
            },
            {
              "textRaw": "`zlib.deflate(buffer[, options], callback)`",
              "name": "deflate",
              "type": "method",
              "meta": {
                "added": [
                  "v0.6.0"
                ],
                "changes": [
                  {
                    "version": "v9.4.0",
                    "pr-url": "https://github.com/nodejs/node/pull/16042",
                    "description": "The `buffer` parameter can be an `ArrayBuffer`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12223",
                    "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12001",
                    "description": "The `buffer` parameter can be an `Uint8Array` now."
                  }
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                      "name": "buffer",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                    },
                    {
                      "textRaw": "`options` {zlib options}",
                      "name": "options",
                      "type": "zlib options",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function}",
                      "name": "callback",
                      "type": "Function"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "`zlib.deflateSync(buffer[, options])`",
              "name": "deflateSync",
              "type": "method",
              "meta": {
                "added": [
                  "v0.11.12"
                ],
                "changes": [
                  {
                    "version": "v9.4.0",
                    "pr-url": "https://github.com/nodejs/node/pull/16042",
                    "description": "The `buffer` parameter can be an `ArrayBuffer`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12223",
                    "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12001",
                    "description": "The `buffer` parameter can be an `Uint8Array` now."
                  }
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                      "name": "buffer",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                    },
                    {
                      "textRaw": "`options` {zlib options}",
                      "name": "options",
                      "type": "zlib options",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "<p>Compress a chunk of data with <a href=\"#class-zlibdeflate\"><code>Deflate</code></a>.</p>"
            },
            {
              "textRaw": "`zlib.deflateRaw(buffer[, options], callback)`",
              "name": "deflateRaw",
              "type": "method",
              "meta": {
                "added": [
                  "v0.6.0"
                ],
                "changes": [
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12223",
                    "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12001",
                    "description": "The `buffer` parameter can be an `Uint8Array` now."
                  }
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                      "name": "buffer",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                    },
                    {
                      "textRaw": "`options` {zlib options}",
                      "name": "options",
                      "type": "zlib options",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function}",
                      "name": "callback",
                      "type": "Function"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "`zlib.deflateRawSync(buffer[, options])`",
              "name": "deflateRawSync",
              "type": "method",
              "meta": {
                "added": [
                  "v0.11.12"
                ],
                "changes": [
                  {
                    "version": "v9.4.0",
                    "pr-url": "https://github.com/nodejs/node/pull/16042",
                    "description": "The `buffer` parameter can be an `ArrayBuffer`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12223",
                    "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12001",
                    "description": "The `buffer` parameter can be an `Uint8Array` now."
                  }
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                      "name": "buffer",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                    },
                    {
                      "textRaw": "`options` {zlib options}",
                      "name": "options",
                      "type": "zlib options",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "<p>Compress a chunk of data with <a href=\"#class-zlibdeflateraw\"><code>DeflateRaw</code></a>.</p>"
            },
            {
              "textRaw": "`zlib.gunzip(buffer[, options], callback)`",
              "name": "gunzip",
              "type": "method",
              "meta": {
                "added": [
                  "v0.6.0"
                ],
                "changes": [
                  {
                    "version": "v9.4.0",
                    "pr-url": "https://github.com/nodejs/node/pull/16042",
                    "description": "The `buffer` parameter can be an `ArrayBuffer`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12223",
                    "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12001",
                    "description": "The `buffer` parameter can be an `Uint8Array` now."
                  }
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                      "name": "buffer",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                    },
                    {
                      "textRaw": "`options` {zlib options}",
                      "name": "options",
                      "type": "zlib options",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function}",
                      "name": "callback",
                      "type": "Function"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "`zlib.gunzipSync(buffer[, options])`",
              "name": "gunzipSync",
              "type": "method",
              "meta": {
                "added": [
                  "v0.11.12"
                ],
                "changes": [
                  {
                    "version": "v9.4.0",
                    "pr-url": "https://github.com/nodejs/node/pull/16042",
                    "description": "The `buffer` parameter can be an `ArrayBuffer`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12223",
                    "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12001",
                    "description": "The `buffer` parameter can be an `Uint8Array` now."
                  }
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                      "name": "buffer",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                    },
                    {
                      "textRaw": "`options` {zlib options}",
                      "name": "options",
                      "type": "zlib options",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "<p>Decompress a chunk of data with <a href=\"#class-zlibgunzip\"><code>Gunzip</code></a>.</p>"
            },
            {
              "textRaw": "`zlib.gzip(buffer[, options], callback)`",
              "name": "gzip",
              "type": "method",
              "meta": {
                "added": [
                  "v0.6.0"
                ],
                "changes": [
                  {
                    "version": "v9.4.0",
                    "pr-url": "https://github.com/nodejs/node/pull/16042",
                    "description": "The `buffer` parameter can be an `ArrayBuffer`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12223",
                    "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12001",
                    "description": "The `buffer` parameter can be an `Uint8Array` now."
                  }
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                      "name": "buffer",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                    },
                    {
                      "textRaw": "`options` {zlib options}",
                      "name": "options",
                      "type": "zlib options",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function}",
                      "name": "callback",
                      "type": "Function"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "`zlib.gzipSync(buffer[, options])`",
              "name": "gzipSync",
              "type": "method",
              "meta": {
                "added": [
                  "v0.11.12"
                ],
                "changes": [
                  {
                    "version": "v9.4.0",
                    "pr-url": "https://github.com/nodejs/node/pull/16042",
                    "description": "The `buffer` parameter can be an `ArrayBuffer`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12223",
                    "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12001",
                    "description": "The `buffer` parameter can be an `Uint8Array` now."
                  }
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                      "name": "buffer",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                    },
                    {
                      "textRaw": "`options` {zlib options}",
                      "name": "options",
                      "type": "zlib options",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "<p>Compress a chunk of data with <a href=\"#class-zlibgzip\"><code>Gzip</code></a>.</p>"
            },
            {
              "textRaw": "`zlib.inflate(buffer[, options], callback)`",
              "name": "inflate",
              "type": "method",
              "meta": {
                "added": [
                  "v0.6.0"
                ],
                "changes": [
                  {
                    "version": "v9.4.0",
                    "pr-url": "https://github.com/nodejs/node/pull/16042",
                    "description": "The `buffer` parameter can be an `ArrayBuffer`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12223",
                    "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12001",
                    "description": "The `buffer` parameter can be an `Uint8Array` now."
                  }
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                      "name": "buffer",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                    },
                    {
                      "textRaw": "`options` {zlib options}",
                      "name": "options",
                      "type": "zlib options",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function}",
                      "name": "callback",
                      "type": "Function"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "`zlib.inflateSync(buffer[, options])`",
              "name": "inflateSync",
              "type": "method",
              "meta": {
                "added": [
                  "v0.11.12"
                ],
                "changes": [
                  {
                    "version": "v9.4.0",
                    "pr-url": "https://github.com/nodejs/node/pull/16042",
                    "description": "The `buffer` parameter can be an `ArrayBuffer`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12223",
                    "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12001",
                    "description": "The `buffer` parameter can be an `Uint8Array` now."
                  }
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                      "name": "buffer",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                    },
                    {
                      "textRaw": "`options` {zlib options}",
                      "name": "options",
                      "type": "zlib options",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "<p>Decompress a chunk of data with <a href=\"#class-zlibinflate\"><code>Inflate</code></a>.</p>"
            },
            {
              "textRaw": "`zlib.inflateRaw(buffer[, options], callback)`",
              "name": "inflateRaw",
              "type": "method",
              "meta": {
                "added": [
                  "v0.6.0"
                ],
                "changes": [
                  {
                    "version": "v9.4.0",
                    "pr-url": "https://github.com/nodejs/node/pull/16042",
                    "description": "The `buffer` parameter can be an `ArrayBuffer`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12223",
                    "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12001",
                    "description": "The `buffer` parameter can be an `Uint8Array` now."
                  }
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                      "name": "buffer",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                    },
                    {
                      "textRaw": "`options` {zlib options}",
                      "name": "options",
                      "type": "zlib options",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function}",
                      "name": "callback",
                      "type": "Function"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "`zlib.inflateRawSync(buffer[, options])`",
              "name": "inflateRawSync",
              "type": "method",
              "meta": {
                "added": [
                  "v0.11.12"
                ],
                "changes": [
                  {
                    "version": "v9.4.0",
                    "pr-url": "https://github.com/nodejs/node/pull/16042",
                    "description": "The `buffer` parameter can be an `ArrayBuffer`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12223",
                    "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12001",
                    "description": "The `buffer` parameter can be an `Uint8Array` now."
                  }
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                      "name": "buffer",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                    },
                    {
                      "textRaw": "`options` {zlib options}",
                      "name": "options",
                      "type": "zlib options",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "<p>Decompress a chunk of data with <a href=\"#class-zlibinflateraw\"><code>InflateRaw</code></a>.</p>"
            },
            {
              "textRaw": "`zlib.unzip(buffer[, options], callback)`",
              "name": "unzip",
              "type": "method",
              "meta": {
                "added": [
                  "v0.6.0"
                ],
                "changes": [
                  {
                    "version": "v9.4.0",
                    "pr-url": "https://github.com/nodejs/node/pull/16042",
                    "description": "The `buffer` parameter can be an `ArrayBuffer`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12223",
                    "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12001",
                    "description": "The `buffer` parameter can be an `Uint8Array` now."
                  }
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                      "name": "buffer",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                    },
                    {
                      "textRaw": "`options` {zlib options}",
                      "name": "options",
                      "type": "zlib options",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function}",
                      "name": "callback",
                      "type": "Function"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "`zlib.unzipSync(buffer[, options])`",
              "name": "unzipSync",
              "type": "method",
              "meta": {
                "added": [
                  "v0.11.12"
                ],
                "changes": [
                  {
                    "version": "v9.4.0",
                    "pr-url": "https://github.com/nodejs/node/pull/16042",
                    "description": "The `buffer` parameter can be an `ArrayBuffer`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12223",
                    "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
                  },
                  {
                    "version": "v8.0.0",
                    "pr-url": "https://github.com/nodejs/node/pull/12001",
                    "description": "The `buffer` parameter can be an `Uint8Array` now."
                  }
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                      "name": "buffer",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                    },
                    {
                      "textRaw": "`options` {zlib options}",
                      "name": "options",
                      "type": "zlib options",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "<p>Decompress a chunk of data with <a href=\"#class-zlibunzip\"><code>Unzip</code></a>.</p>"
            },
            {
              "textRaw": "`zlib.zstdCompress(buffer[, options], callback)`",
              "name": "zstdCompress",
              "type": "method",
              "meta": {
                "added": [
                  "v23.8.0",
                  "v22.15.0"
                ],
                "changes": []
              },
              "stability": 1,
              "stabilityText": "Experimental",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                      "name": "buffer",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                    },
                    {
                      "textRaw": "`options` {zstd options}",
                      "name": "options",
                      "type": "zstd options",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function}",
                      "name": "callback",
                      "type": "Function"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "`zlib.zstdCompressSync(buffer[, options])`",
              "name": "zstdCompressSync",
              "type": "method",
              "meta": {
                "added": [
                  "v23.8.0",
                  "v22.15.0"
                ],
                "changes": []
              },
              "stability": 1,
              "stabilityText": "Experimental",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                      "name": "buffer",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                    },
                    {
                      "textRaw": "`options` {zstd options}",
                      "name": "options",
                      "type": "zstd options",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "<p>Compress a chunk of data with <a href=\"#class-zlibzstdcompress\"><code>ZstdCompress</code></a>.</p>"
            },
            {
              "textRaw": "`zlib.zstdDecompress(buffer[, options], callback)`",
              "name": "zstdDecompress",
              "type": "method",
              "meta": {
                "added": [
                  "v23.8.0",
                  "v22.15.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                      "name": "buffer",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                    },
                    {
                      "textRaw": "`options` {zstd options}",
                      "name": "options",
                      "type": "zstd options",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function}",
                      "name": "callback",
                      "type": "Function"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "`zlib.zstdDecompressSync(buffer[, options])`",
              "name": "zstdDecompressSync",
              "type": "method",
              "meta": {
                "added": [
                  "v23.8.0",
                  "v22.15.0"
                ],
                "changes": []
              },
              "stability": 1,
              "stabilityText": "Experimental",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                      "name": "buffer",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                    },
                    {
                      "textRaw": "`options` {zstd options}",
                      "name": "options",
                      "type": "zstd options",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "<p>Decompress a chunk of data with <a href=\"#class-zlibzstddecompress\"><code>ZstdDecompress</code></a>.</p>"
            }
          ]
        }
      ],
      "meta": {
        "added": [
          "v0.5.8"
        ],
        "changes": []
      },
      "classes": [
        {
          "textRaw": "Class: `zlib.BrotliCompress`",
          "name": "zlib.BrotliCompress",
          "type": "class",
          "meta": {
            "added": [
              "v11.7.0",
              "v10.16.0"
            ],
            "changes": []
          },
          "desc": "<ul>\n<li>Extends: <a href=\"#class-zlibzlibbase\"><code>ZlibBase</code></a></li>\n</ul>\n<p>Compress data using the Brotli algorithm.</p>"
        },
        {
          "textRaw": "Class: `zlib.BrotliDecompress`",
          "name": "zlib.BrotliDecompress",
          "type": "class",
          "meta": {
            "added": [
              "v11.7.0",
              "v10.16.0"
            ],
            "changes": []
          },
          "desc": "<ul>\n<li>Extends: <a href=\"#class-zlibzlibbase\"><code>ZlibBase</code></a></li>\n</ul>\n<p>Decompress data using the Brotli algorithm.</p>"
        },
        {
          "textRaw": "Class: `zlib.Deflate`",
          "name": "zlib.Deflate",
          "type": "class",
          "meta": {
            "added": [
              "v0.5.8"
            ],
            "changes": []
          },
          "desc": "<ul>\n<li>Extends: <a href=\"#class-zlibzlibbase\"><code>ZlibBase</code></a></li>\n</ul>\n<p>Compress data using deflate.</p>"
        },
        {
          "textRaw": "Class: `zlib.DeflateRaw`",
          "name": "zlib.DeflateRaw",
          "type": "class",
          "meta": {
            "added": [
              "v0.5.8"
            ],
            "changes": []
          },
          "desc": "<ul>\n<li>Extends: <a href=\"#class-zlibzlibbase\"><code>ZlibBase</code></a></li>\n</ul>\n<p>Compress data using deflate, and do not append a <code>zlib</code> header.</p>"
        },
        {
          "textRaw": "Class: `zlib.Gunzip`",
          "name": "zlib.Gunzip",
          "type": "class",
          "meta": {
            "added": [
              "v0.5.8"
            ],
            "changes": [
              {
                "version": "v6.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/5883",
                "description": "Trailing garbage at the end of the input stream will now result in an `'error'` event."
              },
              {
                "version": "v5.9.0",
                "pr-url": "https://github.com/nodejs/node/pull/5120",
                "description": "Multiple concatenated gzip file members are supported now."
              },
              {
                "version": "v5.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/2595",
                "description": "A truncated input stream will now result in an `'error'` event."
              }
            ]
          },
          "desc": "<ul>\n<li>Extends: <a href=\"#class-zlibzlibbase\"><code>ZlibBase</code></a></li>\n</ul>\n<p>Decompress a gzip stream.</p>"
        },
        {
          "textRaw": "Class: `zlib.Gzip`",
          "name": "zlib.Gzip",
          "type": "class",
          "meta": {
            "added": [
              "v0.5.8"
            ],
            "changes": []
          },
          "desc": "<ul>\n<li>Extends: <a href=\"#class-zlibzlibbase\"><code>ZlibBase</code></a></li>\n</ul>\n<p>Compress data using gzip.</p>"
        },
        {
          "textRaw": "Class: `zlib.Inflate`",
          "name": "zlib.Inflate",
          "type": "class",
          "meta": {
            "added": [
              "v0.5.8"
            ],
            "changes": [
              {
                "version": "v5.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/2595",
                "description": "A truncated input stream will now result in an `'error'` event."
              }
            ]
          },
          "desc": "<ul>\n<li>Extends: <a href=\"#class-zlibzlibbase\"><code>ZlibBase</code></a></li>\n</ul>\n<p>Decompress a deflate stream.</p>"
        },
        {
          "textRaw": "Class: `zlib.InflateRaw`",
          "name": "zlib.InflateRaw",
          "type": "class",
          "meta": {
            "added": [
              "v0.5.8"
            ],
            "changes": [
              {
                "version": "v6.8.0",
                "pr-url": "https://github.com/nodejs/node/pull/8512",
                "description": "Custom dictionaries are now supported by `InflateRaw`."
              },
              {
                "version": "v5.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/2595",
                "description": "A truncated input stream will now result in an `'error'` event."
              }
            ]
          },
          "desc": "<ul>\n<li>Extends: <a href=\"#class-zlibzlibbase\"><code>ZlibBase</code></a></li>\n</ul>\n<p>Decompress a raw deflate stream.</p>"
        },
        {
          "textRaw": "Class: `zlib.Unzip`",
          "name": "zlib.Unzip",
          "type": "class",
          "meta": {
            "added": [
              "v0.5.8"
            ],
            "changes": []
          },
          "desc": "<ul>\n<li>Extends: <a href=\"#class-zlibzlibbase\"><code>ZlibBase</code></a></li>\n</ul>\n<p>Decompress either a Gzip- or Deflate-compressed stream by auto-detecting\nthe header.</p>"
        },
        {
          "textRaw": "Class: `zlib.ZipBuffer`",
          "name": "zlib.ZipBuffer",
          "type": "class",
          "meta": {
            "added": [
              "v26.8.0"
            ],
            "changes": []
          },
          "stability": 1,
          "stabilityText": "Early development",
          "desc": "<p>The ZIP archive API is experimental. Using any part of it (this class among\nthem) emits an experimental warning the first time; merely importing\n<code>node:zlib</code> does not.</p>\n<p>An in-memory, <strong>zero-copy</strong> view over the entries of a ZIP archive already\nheld in a <code>Buffer</code>, <code>TypedArray</code>, <code>DataView</code>, or <code>ArrayBuffer</code>. Its set of\nentries can be edited - entries added or removed - but, unlike <a href=\"#class-zlibzipfile\"><code>ZipFile</code></a>,\nthose edits are <strong>not</strong> written into the source buffer: a newly added entry is\nheld as a separate in-memory <a href=\"#class-zlibzipentry\"><code>ZipEntry</code></a> (the passed buffer is a fixed-size\nview with no room to append to), and removal just drops the entry from\n<code>ZipBuffer</code>'s index. The original bytes are never modified.\n<a href=\"#zipbuffertobufferoptions\"><code>zipBuffer.toBuffer()</code></a> serializes the current set of entries into a fresh\narchive.</p>\n<p><code>ZipBuffer</code> does not copy the archive you hand it. It keeps a view onto that\nmemory and reads each entry's content lazily and directly from it, which is\nwhat makes construction cheap regardless of archive size. The trade-off is\nthat you <strong>must not modify or reuse</strong> that memory - including the\n<code>ArrayBuffer</code> backing a <code>TypedArray</code>/<code>DataView</code> - while the <code>ZipBuffer</code>, or\nany <a href=\"#class-zlibzipentry\"><code>ZipEntry</code></a> obtained from it, is still in use: a later read would\nobserve the change and may fail or return corrupt data. Pass a copy (for\nexample <code>Buffer.from(source)</code>) if the source might be mutated or reused.</p>\n<p><code>add()</code> and <code>toBuffer()</code> each have a <code>*Sync</code> counterpart\n(<a href=\"#zipbufferaddsyncfilename-data-options\"><code>addSync()</code></a>, <a href=\"#zipbuffertobuffersyncoptions\"><code>toBufferSync()</code></a>)\nthat performs the same compression work synchronously. As with the\nsynchronous <code>node:fs</code> APIs, these block the Node.js event loop and further\nJavaScript execution until the operation completes; use them only where\nsynchronous execution is appropriate (for example, short-lived scripts or\nstartup code), not in code that must stay responsive.</p>\n<pre><code class=\"language-mjs\">import { ZipBuffer } from 'node:zlib';\nimport { readFileSync, writeFileSync } from 'node:fs';\nimport { Buffer } from 'node:buffer';\n\nconst zip = new ZipBuffer(readFileSync('archive.zip'));\nfor (const [name, entry] of zip) {\n  console.log(name, entry.size);\n}\nawait zip.add('hello.txt', Buffer.from('Hello, world!'));\nzip.delete('unwanted.txt');\nwriteFileSync('archive.zip', await zip.toBuffer());\n</code></pre>\n<pre><code class=\"language-cjs\">const { ZipBuffer } = require('node:zlib');\nconst { readFileSync, writeFileSync } = require('node:fs');\n\nasync function main() {\n  const zip = new ZipBuffer(readFileSync('archive.zip'));\n  for (const [name, entry] of zip) {\n    console.log(name, entry.size);\n  }\n  await zip.add('hello.txt', Buffer.from('Hello, world!'));\n  zip.delete('unwanted.txt');\n  writeFileSync('archive.zip', await zip.toBuffer());\n}\nmain();\n</code></pre>",
          "signatures": [
            {
              "textRaw": "`new zlib.ZipBuffer(buffer)`",
              "name": "zlib.ZipBuffer",
              "type": "ctor",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "params": [
                {
                  "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer} A complete ZIP archive.",
                  "name": "buffer",
                  "type": "Buffer|TypedArray|DataView|ArrayBuffer",
                  "desc": "A complete ZIP archive."
                }
              ],
              "desc": "<p>Parses the archive's central directory. Throws an <a href=\"errors.html#err_zip_invalid_archive\"><code>ERR_ZIP_INVALID_ARCHIVE</code></a>\nor <a href=\"errors.html#err_zip_unsupported_feature\"><code>ERR_ZIP_UNSUPPORTED_FEATURE</code></a> error if <code>buffer</code> is not a well-formed,\nsupported archive.</p>\n<p><code>buffer</code> is <strong>not copied</strong>: the <code>ZipBuffer</code> retains a zero-copy view of it (for\na <code>TypedArray</code>, <code>DataView</code>, or <code>ArrayBuffer</code>, of the underlying <code>ArrayBuffer</code>)\nand reads entry content directly from it on demand. Do not mutate or reuse that\nmemory while the <code>ZipBuffer</code> or any entry read from it is still live; pass a\ncopy if it might change.</p>"
            }
          ],
          "methods": [
            {
              "textRaw": "`zipBuffer.add(filename, data[, options])`",
              "name": "add",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`filename` {string} The entry's name within the archive. A trailing `/` marks a directory entry.",
                      "name": "filename",
                      "type": "string",
                      "desc": "The entry's name within the archive. A trailing `/` marks a directory entry."
                    },
                    {
                      "textRaw": "`data` {Buffer|TypedArray|DataView|ArrayBuffer} The entry's complete, uncompressed content.",
                      "name": "data",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer",
                      "desc": "The entry's complete, uncompressed content."
                    },
                    {
                      "textRaw": "`options` {Object} See `zlib.ZipEntry.create()`.",
                      "name": "options",
                      "type": "Object",
                      "desc": "See `zlib.ZipEntry.create()`.",
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Promise} Fulfilled with the created {ZipEntry}.",
                    "name": "return",
                    "type": "Promise",
                    "desc": "Fulfilled with the created {ZipEntry}."
                  }
                }
              ],
              "desc": "<p>Equivalent to <code>zipBuffer.addEntry(await zlib.ZipEntry.create(filename, data, options))</code>.</p>"
            },
            {
              "textRaw": "`zipBuffer.addSync(filename, data[, options])`",
              "name": "addSync",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`filename` {string} The entry's name within the archive. A trailing `/` marks a directory entry.",
                      "name": "filename",
                      "type": "string",
                      "desc": "The entry's name within the archive. A trailing `/` marks a directory entry."
                    },
                    {
                      "textRaw": "`data` {Buffer|TypedArray|DataView|ArrayBuffer} The entry's complete, uncompressed content.",
                      "name": "data",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer",
                      "desc": "The entry's complete, uncompressed content."
                    },
                    {
                      "textRaw": "`options` {Object} See `zlib.ZipEntry.createSync()`.",
                      "name": "options",
                      "type": "Object",
                      "desc": "See `zlib.ZipEntry.createSync()`.",
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {ZipEntry} The created entry.",
                    "name": "return",
                    "type": "ZipEntry",
                    "desc": "The created entry."
                  }
                }
              ],
              "desc": "<p>The synchronous version of <a href=\"#zipbufferaddfilename-data-options\"><code>zipBuffer.add()</code></a>. Equivalent to\n<code>zipBuffer.addEntry(zlib.ZipEntry.createSync(filename, data, options))</code>.</p>"
            },
            {
              "textRaw": "`zipBuffer.addEntry(entry)`",
              "name": "addEntry",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`entry` {ZipEntry}",
                      "name": "entry",
                      "type": "ZipEntry"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {ZipEntry} `entry`.",
                    "name": "return",
                    "type": "ZipEntry",
                    "desc": "`entry`."
                  }
                }
              ],
              "desc": "<p>Adds an already-built entry, keyed by its own <a href=\"#zipentryname\"><code>zipEntry.name</code></a>. Replaces\nany existing entry of that name.</p>"
            },
            {
              "textRaw": "`zipBuffer.clear()`",
              "name": "clear",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": []
                }
              ],
              "desc": "<p>Removes every entry.</p>"
            },
            {
              "textRaw": "`zipBuffer.delete(name)`",
              "name": "delete",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`name` {string}",
                      "name": "name",
                      "type": "string"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean} `true` if an entry named `name` existed and was removed.",
                    "name": "return",
                    "type": "boolean",
                    "desc": "`true` if an entry named `name` existed and was removed."
                  }
                }
              ]
            },
            {
              "textRaw": "`zipBuffer.entries()`",
              "name": "entries",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [],
                  "return": {
                    "textRaw": "Returns: {Iterator} of `[name, entry]` pairs, where `entry` is a `ZipEntry`.",
                    "name": "return",
                    "type": "Iterator",
                    "desc": "of `[name, entry]` pairs, where `entry` is a `ZipEntry`."
                  }
                }
              ]
            },
            {
              "textRaw": "`zipBuffer.forEach(callback[, thisArg])`",
              "name": "forEach",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`callback` {Function}",
                      "name": "callback",
                      "type": "Function"
                    },
                    {
                      "textRaw": "`thisArg` {any}",
                      "name": "thisArg",
                      "type": "any",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "<p>Calls <code>callback</code> once for each entry, in the order the archive lists them.</p>"
            },
            {
              "textRaw": "`zipBuffer.get(name)`",
              "name": "get",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`name` {string}",
                      "name": "name",
                      "type": "string"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {ZipEntry}",
                    "name": "return",
                    "type": "ZipEntry"
                  }
                }
              ],
              "desc": "<p>Throws <a href=\"errors.html#err_zip_entry_not_found\"><code>ERR_ZIP_ENTRY_NOT_FOUND</code></a> if the archive has no entry named <code>name</code>.</p>"
            },
            {
              "textRaw": "`zipBuffer.has(name)`",
              "name": "has",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`name` {string}",
                      "name": "name",
                      "type": "string"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ]
            },
            {
              "textRaw": "`zipBuffer.keys()`",
              "name": "keys",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [],
                  "return": {
                    "textRaw": "Returns: {Iterator} of entry names.",
                    "name": "return",
                    "type": "Iterator",
                    "desc": "of entry names."
                  }
                }
              ]
            },
            {
              "textRaw": "`zipBuffer.toBuffer([options])`",
              "name": "toBuffer",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`options` {string|Object} An archive comment, as a shorthand for `{ comment: options }`.",
                      "name": "options",
                      "type": "string|Object",
                      "desc": "An archive comment, as a shorthand for `{ comment: options }`.",
                      "options": [
                        {
                          "textRaw": "`comment` {string} An archive comment. **Default:** `zipBuffer.comment`.",
                          "name": "comment",
                          "type": "string",
                          "default": "`zipBuffer.comment`",
                          "desc": "An archive comment."
                        },
                        {
                          "textRaw": "`baseOffset` {number} Shifts every offset the archive records by this many bytes, so the serialized archive is self-describing even when it is written somewhere other than the start of its eventual file - for example, after `baseOffset` bytes of other content already written to the same output. **Default:** `0`.",
                          "name": "baseOffset",
                          "type": "number",
                          "default": "`0`",
                          "desc": "Shifts every offset the archive records by this many bytes, so the serialized archive is self-describing even when it is written somewhere other than the start of its eventual file - for example, after `baseOffset` bytes of other content already written to the same output."
                        }
                      ],
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Promise} Fulfilled with a {Buffer} containing the serialized archive.",
                    "name": "return",
                    "type": "Promise",
                    "desc": "Fulfilled with a {Buffer} containing the serialized archive."
                  }
                }
              ],
              "desc": "<p>Serializes the current set of entries - in the order they were added or\nread - into a fresh archive, switching to Zip64 structures automatically as\nneeded (see <a href=\"#zlibcreateziparchiveentries-options\"><code>zlib.createZipArchive()</code></a>).</p>"
            },
            {
              "textRaw": "`zipBuffer.toBufferSync([options])`",
              "name": "toBufferSync",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`options` {string|Object} See `zipBuffer.toBuffer()`.",
                      "name": "options",
                      "type": "string|Object",
                      "desc": "See `zipBuffer.toBuffer()`.",
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Buffer} The serialized archive.",
                    "name": "return",
                    "type": "Buffer",
                    "desc": "The serialized archive."
                  }
                }
              ],
              "desc": "<p>The synchronous version of <a href=\"#zipbuffertobufferoptions\"><code>zipBuffer.toBuffer()</code></a> (see\n<a href=\"#zlibcreateziparchivesyncentries-options\"><code>zlib.createZipArchiveSync()</code></a>).</p>"
            },
            {
              "textRaw": "`zipBuffer.values()`",
              "name": "values",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [],
                  "return": {
                    "textRaw": "Returns: {Iterator} of `ZipEntry`.",
                    "name": "return",
                    "type": "Iterator",
                    "desc": "of `ZipEntry`."
                  }
                }
              ]
            }
          ],
          "properties": [
            {
              "textRaw": "Type: {string}",
              "name": "comment",
              "type": "string",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "desc": "<p>The archive-level comment, preserved byte-for-byte across\n<a href=\"#zipbuffertobufferoptions\"><code>zipBuffer.toBuffer()</code></a> calls unless overridden. The bytes are decoded as\nUTF-8 when they are valid UTF-8 and as CP437 otherwise (the field carries no\nencoding flag of its own).</p>"
            },
            {
              "textRaw": "Type: {number}",
              "name": "size",
              "type": "number",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "desc": "<p>The number of entries in the archive.</p>"
            },
            {
              "textRaw": "Type: {boolean}",
              "name": "writable",
              "type": "boolean",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "desc": "<p>Always <code>true</code>.</p>"
            }
          ]
        },
        {
          "textRaw": "Class: `zlib.ZipEntry`",
          "name": "zlib.ZipEntry",
          "type": "class",
          "meta": {
            "added": [
              "v26.8.0"
            ],
            "changes": []
          },
          "stability": 1,
          "stabilityText": "Early development",
          "desc": "<p>The ZIP archive API is experimental. Using any part of it (this class among\nthem) emits an experimental warning the first time; merely importing\n<code>node:zlib</code> does not.</p>\n<p>A single file or directory inside a ZIP archive. Instances are produced by\n<a href=\"#class-zlibzipbuffer\"><code>ZipBuffer</code></a> and <a href=\"#class-zlibzipfile\"><code>ZipFile</code></a>, or created directly for writing with\n<code>ZipEntry.create()</code>/<code>ZipEntry.createStream()</code>.</p>\n<p><code>create()</code> and <code>content()</code> each have a <code>*Sync</code> counterpart (the streaming\n<code>contentIterator()</code> does not). As with the synchronous <code>node:fs</code> APIs, these\nblock the\nNode.js event loop and further JavaScript execution until the operation\n(including any deflate/inflate pass) completes; use them only where\nsynchronous execution is appropriate (for example, short-lived scripts or\nstartup code), not in code that must stay responsive.</p>",
          "classMethods": [
            {
              "textRaw": "Static method: `zlib.ZipEntry.create(filename, data[, options])`",
              "name": "create",
              "type": "classMethod",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`filename` {string} The entry's name within the archive. A trailing `/` marks a directory entry.",
                      "name": "filename",
                      "type": "string",
                      "desc": "The entry's name within the archive. A trailing `/` marks a directory entry."
                    },
                    {
                      "textRaw": "`data` {Buffer|TypedArray|DataView|ArrayBuffer} The entry's complete, uncompressed content. Must be empty when `filename` names a directory.",
                      "name": "data",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer",
                      "desc": "The entry's complete, uncompressed content. Must be empty when `filename` names a directory."
                    },
                    {
                      "textRaw": "`options` {Object}",
                      "name": "options",
                      "type": "Object",
                      "options": [
                        {
                          "textRaw": "`comment` {string} An entry comment.",
                          "name": "comment",
                          "type": "string",
                          "desc": "An entry comment."
                        },
                        {
                          "textRaw": "`mode` {integer} Unix permission bits. **Default:** `0o644` (`0o755` for directories).",
                          "name": "mode",
                          "type": "integer",
                          "default": "`0o644` (`0o755` for directories)",
                          "desc": "Unix permission bits."
                        },
                        {
                          "textRaw": "`modified` {Date} The entry's modification time. **Default:** the current time.",
                          "name": "modified",
                          "type": "Date",
                          "default": "the current time",
                          "desc": "The entry's modification time."
                        },
                        {
                          "textRaw": "`method` {string} One of `'deflate'`, `'store'`, or `'zstd'`. **Default:** `'deflate'`, except for directories and empty content, which are always stored.",
                          "name": "method",
                          "type": "string",
                          "default": "`'deflate'`, except for directories and empty content, which are always stored",
                          "desc": "One of `'deflate'`, `'store'`, or `'zstd'`."
                        }
                      ],
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Promise} Fulfilled with a {ZipEntry}.",
                    "name": "return",
                    "type": "Promise",
                    "desc": "Fulfilled with a {ZipEntry}."
                  }
                }
              ],
              "desc": "<p>Compresses <code>data</code> (unless <code>method</code> is <code>'store'</code>, or compression would not\nreduce its size) and computes its CRC-32.</p>\n<p>When the entry ends up stored uncompressed (because <code>method</code> is <code>'store'</code>,\nor because compression would not reduce the size), the entry retains a\nzero-copy view of <code>data</code> rather than a copy, and its CRC-32 has already been\nrecorded. Do not mutate <code>data</code> after creating the entry; pass a copy if it\nmight change.</p>\n<p>The MS-DOS date/time fields ZIP uses for <code>modified</code> have 2-second resolution\nand no time zone. When <code>modified</code> does not fall on a whole 2-second\nboundary, an Info-ZIP extended-timestamp extra field is written as well,\nrecording the whole (UTC) second so the time round-trips more precisely (see\n<a href=\"#zipentrymodified\"><code>zipEntry.modified</code></a>). This applies to every entry-creation path.</p>"
            },
            {
              "textRaw": "Static method: `zlib.ZipEntry.createStream(filename, source[, options])`",
              "name": "createStream",
              "type": "classMethod",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`filename` {string} The entry's name within the archive. Must not end in `/`.",
                      "name": "filename",
                      "type": "string",
                      "desc": "The entry's name within the archive. Must not end in `/`."
                    },
                    {
                      "textRaw": "`source` {AsyncIterable} Yields the entry's uncompressed content as `Uint8Array` chunks.",
                      "name": "source",
                      "type": "AsyncIterable",
                      "desc": "Yields the entry's uncompressed content as `Uint8Array` chunks."
                    },
                    {
                      "textRaw": "`options` {Object}",
                      "name": "options",
                      "type": "Object",
                      "options": [
                        {
                          "textRaw": "`comment` {string} An entry comment.",
                          "name": "comment",
                          "type": "string",
                          "desc": "An entry comment."
                        },
                        {
                          "textRaw": "`mode` {integer} Unix permission bits. **Default:** `0o644`.",
                          "name": "mode",
                          "type": "integer",
                          "default": "`0o644`",
                          "desc": "Unix permission bits."
                        },
                        {
                          "textRaw": "`modified` {Date} The entry's modification time. **Default:** the current time.",
                          "name": "modified",
                          "type": "Date",
                          "default": "the current time",
                          "desc": "The entry's modification time."
                        },
                        {
                          "textRaw": "`method` {string} One of `'deflate'`, `'store'`, or `'zstd'`. **Default:** `'deflate'`.",
                          "name": "method",
                          "type": "string",
                          "default": "`'deflate'`",
                          "desc": "One of `'deflate'`, `'store'`, or `'zstd'`."
                        }
                      ],
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {ZipEntry}",
                    "name": "return",
                    "type": "ZipEntry"
                  }
                }
              ],
              "desc": "<p>Creates an entry whose content is compressed on the fly as it is serialized\nby <a href=\"#zlibcreateziparchiveentries-options\"><code>zlib.createZipArchive()</code></a>, without buffering <code>source</code> in memory. Its\n<code>size</code>, <code>compressedSize</code>, and <code>crc32</code> only become available once\nserialization has finished. There is no synchronous counterpart: streaming\nentries only make sense with an asynchronous, incrementally-produced\n<code>source</code>.</p>\n<p><code>source</code> is drained exactly once, during serialization. Until that happens\nthe entry has no readable content, so <a href=\"#zipentrycontentoptions\"><code>zipEntry.content()</code></a>,\n<a href=\"#zipentrycontentsyncoptions\"><code>zipEntry.contentSync()</code></a>, and <a href=\"#zipentrycontentiteratoroptions\"><code>zipEntry.contentIterator()</code></a> throw\n<a href=\"errors.html#err_invalid_state\"><code>ERR_INVALID_STATE</code></a>. If the entry is serialized by adding it to a writable\n<a href=\"#class-zlibzipfile\"><code>ZipFile</code></a> with <a href=\"#zipfileaddentryentry\"><code>zipFile.addEntry()</code></a> (or <code>addEntrySync()</code>), it is then\n<strong>promoted in place</strong> to a file-backed entry pointing at the copy just written,\nso it becomes readable (and can be serialized again) for as long as that\n<code>ZipFile</code> stays open. Serializing it any other way (for example directly\nthrough <a href=\"#zlibcreateziparchiveentries-options\"><code>zlib.createZipArchive()</code></a>) leaves it spent and unreadable.</p>\n<p>Because <code>source</code> may hold an operating-system resource (a file read stream,\nsay), a streaming entry is disposable: its <code>Symbol.dispose</code> and\n<code>Symbol.asyncDispose</code> methods destroy <code>source</code> if it has not been consumed.\nAn entry passed to an archive is disposed by that archive (see\n<a href=\"#zlibcreateziparchiveentries-options\"><code>zlib.createZipArchive()</code></a>); dispose an entry directly only when it was\nbuilt but never handed to one. Disposal is a no-op for non-streaming entries -\nin particular a file-backed entry never closes the <a href=\"#class-zlibzipfile\"><code>ZipFile</code></a> descriptor it\nborrows.</p>"
            },
            {
              "textRaw": "Static method: `zlib.ZipEntry.createSymlink(filename, target[, options])`",
              "name": "createSymlink",
              "type": "classMethod",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`filename` {string} The entry's name within the archive.",
                      "name": "filename",
                      "type": "string",
                      "desc": "The entry's name within the archive."
                    },
                    {
                      "textRaw": "`target` {string} The symbolic link's target path.",
                      "name": "target",
                      "type": "string",
                      "desc": "The symbolic link's target path."
                    },
                    {
                      "textRaw": "`options` {Object}",
                      "name": "options",
                      "type": "Object",
                      "options": [
                        {
                          "textRaw": "`comment` {string} An entry comment.",
                          "name": "comment",
                          "type": "string",
                          "desc": "An entry comment."
                        },
                        {
                          "textRaw": "`mode` {integer} Unix permission bits. **Default:** `0o777`.",
                          "name": "mode",
                          "type": "integer",
                          "default": "`0o777`",
                          "desc": "Unix permission bits."
                        },
                        {
                          "textRaw": "`modified` {Date} The entry's modification time. **Default:** the current time.",
                          "name": "modified",
                          "type": "Date",
                          "default": "the current time",
                          "desc": "The entry's modification time."
                        }
                      ],
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {ZipEntry}",
                    "name": "return",
                    "type": "ZipEntry"
                  }
                }
              ],
              "desc": "<p>Creates a symbolic-link entry: a stored entry whose content is <code>target</code> and\nwhose Unix mode type bits mark it as a symlink, so <a href=\"#zipentryissymlink\"><code>zipEntry.isSymlink</code></a> is\n<code>true</code> when it is read back. Extraction tools that honor symlink entries\nrecreate the link; treat <code>target</code> as untrusted (see <a href=\"#zipentryname\"><code>zipEntry.name</code></a> on\npath safety).</p>"
            },
            {
              "textRaw": "Static method: `zlib.ZipEntry.createSync(filename, data[, options])`",
              "name": "createSync",
              "type": "classMethod",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`filename` {string} The entry's name within the archive. A trailing `/` marks a directory entry.",
                      "name": "filename",
                      "type": "string",
                      "desc": "The entry's name within the archive. A trailing `/` marks a directory entry."
                    },
                    {
                      "textRaw": "`data` {Buffer|TypedArray|DataView|ArrayBuffer} The entry's complete, uncompressed content. Must be empty when `filename` names a directory.",
                      "name": "data",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer",
                      "desc": "The entry's complete, uncompressed content. Must be empty when `filename` names a directory."
                    },
                    {
                      "textRaw": "`options` {Object} See `zlib.ZipEntry.create()`.",
                      "name": "options",
                      "type": "Object",
                      "desc": "See `zlib.ZipEntry.create()`.",
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {ZipEntry}",
                    "name": "return",
                    "type": "ZipEntry"
                  }
                }
              ],
              "desc": "<p>The synchronous version of <a href=\"#static-method-zlibzipentrycreatefilename-data-options\"><code>zlib.ZipEntry.create()</code></a>.</p>"
            },
            {
              "textRaw": "Static method: `zlib.ZipEntry.read(buffer)`",
              "name": "read",
              "type": "classMethod",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer} A complete ZIP archive.",
                      "name": "buffer",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer",
                      "desc": "A complete ZIP archive."
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Iterator} of {ZipEntry}.",
                    "name": "return",
                    "type": "Iterator",
                    "desc": "of {ZipEntry}."
                  }
                }
              ],
              "desc": "<p>Parses every entry out of <code>buffer</code> directly, without indexing it into a\n<a href=\"#class-zlibzipbuffer\"><code>ZipBuffer</code></a>. Like <a href=\"#class-zlibzipbuffer\"><code>ZipBuffer</code></a>, the yielded entries hold zero-copy views\nof <code>buffer</code> rather than copies of their content, so the same rule applies: do\nnot mutate or reuse <code>buffer</code> while any of them is still in use.</p>"
            }
          ],
          "properties": [
            {
              "textRaw": "Type: {string}",
              "name": "comment",
              "type": "string",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              }
            },
            {
              "textRaw": "Type: {boolean}",
              "name": "compressed",
              "type": "boolean",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "desc": "<p><code>true</code> if the entry's content is stored in compressed form (any compression\nmethod, currently deflate or Zstandard); <code>false</code> if it is stored\nuncompressed.</p>"
            },
            {
              "textRaw": "Type: {number}",
              "name": "compressedSize",
              "type": "number",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              }
            },
            {
              "textRaw": "Type: {number}",
              "name": "crc32",
              "type": "number",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              }
            },
            {
              "textRaw": "Type: {number}",
              "name": "flags",
              "type": "number",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "desc": "<p>The entry's raw general-purpose bit flag.</p>"
            },
            {
              "textRaw": "Type: {boolean}",
              "name": "isDirectory",
              "type": "boolean",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "desc": "<p><code>true</code> if the entry is a directory (its name ends with <code>/</code>).</p>"
            },
            {
              "textRaw": "Type: {boolean}",
              "name": "isFile",
              "type": "boolean",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "desc": "<p><code>true</code> if the entry is a regular file — that is, neither a directory nor a\nsymbolic link.</p>"
            },
            {
              "textRaw": "Type: {boolean}",
              "name": "isSymlink",
              "type": "boolean",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "desc": "<p><code>true</code> if the entry is a symbolic link (its Unix mode type bits are\n<code>S_IFLNK</code>); its content is the link target. Always <code>false</code> for archives not\nwritten on a Unix-like system. When extracting, treat a symlink's target as\nuntrusted — see <a href=\"#zipentryname\"><code>zipEntry.name</code></a> on path safety.</p>"
            },
            {
              "textRaw": "Type: {number}",
              "name": "mode",
              "type": "number",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "desc": "<p>The entry's Unix mode permission bits, including the setuid, setgid, and\nsticky bits (the low 12 bits, <code>0o7777</code>), or <code>0</code> if the archive was not written\non a Unix-like system. The file-type bits are not included here; use\n<a href=\"#zipentryisdirectory\"><code>zipEntry.isDirectory</code></a> / <a href=\"#zipentryissymlink\"><code>zipEntry.isSymlink</code></a> for the type.</p>"
            },
            {
              "textRaw": "Type: {Date}",
              "name": "modified",
              "type": "Date",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "desc": "<p>The entry's last-modification time. When the archive carries a higher-fidelity\ntimestamp in an extra field — an NTFS (<code>0x000a</code>), Info-ZIP extended (<code>0x5455</code>),\nor Info-ZIP Unix (<code>0x5855</code>) field, as most modern tools write — that absolute\n(UTC) time is used; otherwise the coarse, local-time MS-DOS date/time field\n(2-second resolution) is used.</p>\n<p>Some tools store their high-fidelity timestamp only in the local file header,\nso on a file-backed entry (one returned by <a href=\"#zipfilegetname\"><code>zipFile.get()</code></a>) the first read\nof this property may perform a small synchronous positioned disk read to\nresolve that header. If that read fails, the value silently falls back to the\ncentral-directory data.</p>"
            },
            {
              "textRaw": "Type: {number}",
              "name": "method",
              "type": "number",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "desc": "<p>The entry's raw compression method: <code>0</code> for stored, <code>8</code> for deflate, <code>93</code>\nfor Zstandard.</p>"
            },
            {
              "textRaw": "Type: {string}",
              "name": "name",
              "type": "string",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "desc": "<p>The entry's name, decoded from the central directory, which is treated as\nauthoritative — a local file header that disagrees is ignored, so a\nmismatched-header (\"ZIP-confusion\") archive cannot make <code>name</code> disagree with\nwhat is read. The bytes are decoded from a valid Info-ZIP Unicode Path extra\nfield (<code>0x7075</code>) when one is present; otherwise as UTF-8 when the\nlanguage-encoding flag (general-purpose bit 11) is set <strong>or the bytes are\nvalid UTF-8</strong> (plenty of tools wrote UTF-8 names without ever setting the\nflag); and as CP437 — the historical default — only when they are not.\nSee <a href=\"#zipentrynamebuffer\"><code>zipEntry.nameBuffer</code></a> for the raw bytes.</p>\n<p>The name is returned <strong>verbatim</strong>: it is never normalized, and a name\ncontaining <code>..</code>, a leading <code>/</code>, a drive letter, or backslashes is neither\nrewritten nor rejected. A <code>ZipFile</code>/<code>ZipBuffer</code> never writes to disk, so\nguarding against path traversal (\"Zip Slip\") when extracting is the caller's\nresponsibility.</p>"
            },
            {
              "textRaw": "Type: {Buffer}",
              "name": "nameBuffer",
              "type": "Buffer",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "desc": "<p>The entry's raw name bytes, before any character decoding. Useful when the\narchive's names are in an encoding other than UTF-8 or CP437 and the caller\nwants to decode them itself.</p>"
            },
            {
              "textRaw": "Type: {Buffer|null}",
              "name": "rawContent",
              "type": "Buffer|null",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "desc": "<p>The entry's raw (still compressed, if applicable) content when it is held in\nmemory, or <code>null</code> when there is no in-memory buffer to expose - for an entry\ncreated with <a href=\"#static-method-zlibzipentrycreatestreamfilename-source-options\"><code>zlib.ZipEntry.createStream()</code></a>, or a file-backed entry\nreturned by <a href=\"#zipfilegetname\"><code>zipFile.get()</code></a>, whose bytes are read from disk on demand\nrather than retained. Use <a href=\"#zipentrycontentoptions\"><code>zipEntry.content()</code></a> or\n<a href=\"#zipentrycontentiteratoroptions\"><code>zipEntry.contentIterator()</code></a> to read a file-backed entry.</p>"
            },
            {
              "textRaw": "Type: {number}",
              "name": "size",
              "type": "number",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "desc": "<p>The entry's uncompressed size, in bytes.</p>"
            }
          ],
          "methods": [
            {
              "textRaw": "`zipEntry.content([options])`",
              "name": "content",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`options` {Object}",
                      "name": "options",
                      "type": "Object",
                      "options": [
                        {
                          "textRaw": "`verify` {boolean} Verify the entry's CRC-32 checksum. **Default:** `true`.",
                          "name": "verify",
                          "type": "boolean",
                          "default": "`true`",
                          "desc": "Verify the entry's CRC-32 checksum."
                        },
                        {
                          "textRaw": "`maxSize` {number} Reject content declaring more than this many uncompressed bytes, before allocating anything. **Default:** `zlib.getMaxZipContentSize()`.",
                          "name": "maxSize",
                          "type": "number",
                          "default": "`zlib.getMaxZipContentSize()`",
                          "desc": "Reject content declaring more than this many uncompressed bytes, before allocating anything."
                        }
                      ],
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Promise} Fulfilled with a {Buffer} containing the entry's decompressed content. The buffer is a fresh copy that shares no memory with the archive or with data the entry was created from.",
                    "name": "return",
                    "type": "Promise",
                    "desc": "Fulfilled with a {Buffer} containing the entry's decompressed content. The buffer is a fresh copy that shares no memory with the archive or with data the entry was created from."
                  }
                }
              ],
              "desc": "<p>Throws an <a href=\"errors.html#err_zip_entry_too_large\"><code>ERR_ZIP_ENTRY_TOO_LARGE</code></a> error if the entry's declared size\nexceeds <code>maxSize</code>, an <a href=\"errors.html#err_zip_entry_corrupt\"><code>ERR_ZIP_ENTRY_CORRUPT</code></a> error if the content fails\nCRC-32 verification or does not match its declared size, and an\n<a href=\"errors.html#err_invalid_state\"><code>ERR_INVALID_STATE</code></a> error for a streaming entry\n(<a href=\"#static-method-zlibzipentrycreatestreamfilename-source-options\"><code>zlib.ZipEntry.createStream()</code></a>) whose content is not yet available (see\nthat method for when a streaming entry becomes readable).</p>"
            },
            {
              "textRaw": "`zipEntry.contentSync([options])`",
              "name": "contentSync",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`options` {Object} See `zipEntry.content()`.",
                      "name": "options",
                      "type": "Object",
                      "desc": "See `zipEntry.content()`.",
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Buffer} The entry's decompressed content.",
                    "name": "return",
                    "type": "Buffer",
                    "desc": "The entry's decompressed content."
                  }
                }
              ],
              "desc": "<p>The synchronous version of <a href=\"#zipentrycontentoptions\"><code>zipEntry.content()</code></a>.</p>"
            },
            {
              "textRaw": "`zipEntry.contentIterator([options])`",
              "name": "contentIterator",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`options` {Object}",
                      "name": "options",
                      "type": "Object",
                      "options": [
                        {
                          "textRaw": "`verify` {boolean} Verify the entry's CRC-32 checksum. **Default:** `true`.",
                          "name": "verify",
                          "type": "boolean",
                          "default": "`true`",
                          "desc": "Verify the entry's CRC-32 checksum."
                        },
                        {
                          "textRaw": "`maxSize` {number} Reject content declaring more than this many uncompressed bytes, before decompressing anything. **Default:** no limit.",
                          "name": "maxSize",
                          "type": "number",
                          "default": "no limit",
                          "desc": "Reject content declaring more than this many uncompressed bytes, before decompressing anything."
                        }
                      ],
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {AsyncIterator} of {Buffer} chunks of the entry's decompressed content.",
                    "name": "return",
                    "type": "AsyncIterator",
                    "desc": "of {Buffer} chunks of the entry's decompressed content."
                  }
                }
              ],
              "desc": "<p>Unlike <a href=\"#zipentrycontentoptions\"><code>zipEntry.content()</code></a>, this does not buffer the whole member in\nmemory. For a file-backed entry (one returned by <a href=\"#zipfilegetname\"><code>zipFile.get()</code></a>) the\ncompressed bytes are read from disk as the iterator is consumed and nothing is\nretained; the entry is valid only while its <code>ZipFile</code> is open.</p>\n<p>Because streaming is the bounded-memory path for arbitrarily large members, it\nis <strong>not</strong> capped by <a href=\"#zlibgetmaxzipcontentsize\"><code>zlib.getMaxZipContentSize()</code></a> the way\n<a href=\"#zipentrycontentoptions\"><code>zipEntry.content()</code></a> is - that default guards a single large allocation,\nwhich streaming never makes. Output is still bounded per chunk to the declared\nuncompressed size; pass <code>maxSize</code> to impose an explicit ceiling.</p>\n<p>For an in-memory entry stored without compression, the yielded chunks are\nzero-copy views of the entry's retained content (see\n<a href=\"#zipentryrawcontent\"><code>zipEntry.rawContent</code></a>); do not mutate them.</p>\n<p>The yielded chunks are <strong>provisional until the iterator completes</strong>. CRC-32\nverification (and the final declared-size check) can only run once every byte\nhas been read, so a corrupt or truncated entry is reported by the iterator\nthrowing <em>after</em> the last chunk, not before the first. Each chunk is still\nbounded so the total never exceeds the declared size or <code>maxSize</code>, but a\nconsumer that must not act on unverified bytes should buffer them (or use\n<a href=\"#zipentrycontentoptions\"><code>zipEntry.content()</code></a>, which verifies before returning anything) rather than\nprocessing chunks as they arrive.</p>"
            }
          ]
        },
        {
          "textRaw": "Class: `zlib.ZipFile`",
          "name": "zlib.ZipFile",
          "type": "class",
          "meta": {
            "added": [
              "v26.8.0"
            ],
            "changes": []
          },
          "stability": 1,
          "stabilityText": "Early development",
          "desc": "<p>The ZIP archive API is experimental. Using any part of it (this class among\nthem) emits an experimental warning the first time; merely importing\n<code>node:zlib</code> does not.</p>\n<p>A random-access view over the entries of a ZIP archive on disk. Only the\narchive's tail and central directory are read up front; member content is\nread from disk lazily, on demand. Writable when opened with\n<code>{ writable: true }</code>: <a href=\"#zipfileaddentryentry\"><code>zipFile.addEntry()</code></a>/<a href=\"#zipfileaddfilename-data-options\"><code>zipFile.add()</code></a> append the\nnew member's data where the central directory used to be, then rewrite the\ncentral directory immediately after it; <a href=\"#zipfiledeletename\"><code>zipFile.delete()</code></a> just rewrites\nthe central directory. Both mean the file is altered as soon as the method's\nreturned <code>Promise</code> fulfills. Deleted or replaced members are left behind as\ndead space; <a href=\"#zipfilecompactcomment\"><code>zipFile.compact()</code></a> produces a stream with none.</p>\n<p>These in-place edits are <strong>not crash-atomic</strong>. Rewriting the central directory\nhappens in place, so a write that fails partway - the disk fills, the device\ndisconnects, the process is killed - can leave the archive on disk with a\npartial or missing central directory, i.e. unreadable, even though the member\ndata before it is intact. The rejected call surfaces the underlying error and\nthe <code>ZipFile</code> object is left usable (its in-memory view is not discarded, so a\ncaller can attempt recovery - for example re-writing the entries elsewhere with\n<a href=\"#zipfilecompactcomment\"><code>zipFile.compact()</code></a>), but that in-memory view may no longer match the bytes\non disk. Write to a copy, or <code>compact()</code> into a fresh file, when durability\nacross a failure matters.</p>\n<p>Every method has a <code>*Sync</code> counterpart. As with the synchronous <code>node:fs</code>\nAPIs, these block the Node.js event loop and further JavaScript execution\nuntil the operation completes; use them only where synchronous execution is\nappropriate (for example, short-lived scripts or startup code), not in code\nthat must stay responsive. A synchronous method throws <code>ERR_INVALID_STATE</code>\nif called while an asynchronous <code>add()</code>, <code>addEntry()</code>, <code>delete()</code>, or\n<code>close()</code> on the same <code>ZipFile</code> has not settled yet, since letting the two\ninterleave could corrupt the archive.</p>\n<pre><code class=\"language-mjs\">import { ZipFile } from 'node:zlib';\nimport { Buffer } from 'node:buffer';\n\nconst zip = await ZipFile.open('archive.zip', { writable: true });\ntry {\n  const entry = await zip.get('member.txt');\n  console.log((await entry.content()).toString());\n  for await (const chunk of await zip.stream('huge.bin')) {\n    // Process each chunk without buffering the whole member.\n  }\n  await zip.add('new.txt', Buffer.from('hello'));\n  await zip.delete('unwanted.txt');\n} finally {\n  await zip.close();\n}\n</code></pre>\n<pre><code class=\"language-cjs\">const { ZipFile } = require('node:zlib');\n\nasync function main() {\n  const zip = await ZipFile.open('archive.zip', { writable: true });\n  try {\n    const entry = await zip.get('member.txt');\n    console.log((await entry.content()).toString());\n    for await (const chunk of await zip.stream('huge.bin')) {\n      // Process each chunk without buffering the whole member.\n    }\n    await zip.add('new.txt', Buffer.from('hello'));\n    await zip.delete('unwanted.txt');\n  } finally {\n    await zip.close();\n  }\n}\nmain();\n</code></pre>",
          "classMethods": [
            {
              "textRaw": "Static method: `zlib.ZipFile.open(filename[, options])`",
              "name": "open",
              "type": "classMethod",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`filename` {string}",
                      "name": "filename",
                      "type": "string"
                    },
                    {
                      "textRaw": "`options` {Object}",
                      "name": "options",
                      "type": "Object",
                      "options": [
                        {
                          "textRaw": "`writable` {boolean} Open the underlying file for both reading and writing (`'r+'`), enabling `zipFile.addEntry()`/`zipFile.add()`/ `zipFile.delete()`. **Default:** `false`.",
                          "name": "writable",
                          "type": "boolean",
                          "default": "`false`",
                          "desc": "Open the underlying file for both reading and writing (`'r+'`), enabling `zipFile.addEntry()`/`zipFile.add()`/ `zipFile.delete()`."
                        }
                      ],
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Promise} Fulfilled with a {ZipFile}.",
                    "name": "return",
                    "type": "Promise",
                    "desc": "Fulfilled with a {ZipFile}."
                  }
                }
              ],
              "desc": "<p>Throws an <a href=\"errors.html#err_zip_archive_too_large\"><code>ERR_ZIP_ARCHIVE_TOO_LARGE</code></a> error if the archive's central\ndirectory is too large to buffer in memory.</p>"
            },
            {
              "textRaw": "Static method: `zlib.ZipFile.openSync(filename[, options])`",
              "name": "openSync",
              "type": "classMethod",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`filename` {string}",
                      "name": "filename",
                      "type": "string"
                    },
                    {
                      "textRaw": "`options` {Object} See `zlib.ZipFile.open()`.",
                      "name": "options",
                      "type": "Object",
                      "desc": "See `zlib.ZipFile.open()`.",
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {ZipFile}",
                    "name": "return",
                    "type": "ZipFile"
                  }
                }
              ],
              "desc": "<p>The synchronous version of <a href=\"#static-method-zlibzipfileopenfilename-options\"><code>zlib.ZipFile.open()</code></a>.</p>"
            }
          ],
          "methods": [
            {
              "textRaw": "`zipFile.add(filename, data[, options])`",
              "name": "add",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`filename` {string} The entry's name within the archive. A trailing `/` marks a directory entry.",
                      "name": "filename",
                      "type": "string",
                      "desc": "The entry's name within the archive. A trailing `/` marks a directory entry."
                    },
                    {
                      "textRaw": "`data` {Buffer|TypedArray|DataView|ArrayBuffer} The entry's complete, uncompressed content.",
                      "name": "data",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer",
                      "desc": "The entry's complete, uncompressed content."
                    },
                    {
                      "textRaw": "`options` {Object} See `zlib.ZipEntry.create()`.",
                      "name": "options",
                      "type": "Object",
                      "desc": "See `zlib.ZipEntry.create()`.",
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Promise} Fulfilled with the created {ZipEntry}.",
                    "name": "return",
                    "type": "Promise",
                    "desc": "Fulfilled with the created {ZipEntry}."
                  }
                }
              ],
              "desc": "<p>Equivalent to <code>zipFile.addEntry(await zlib.ZipEntry.create(filename, data, options))</code>.</p>"
            },
            {
              "textRaw": "`zipFile.addEntry(entry)`",
              "name": "addEntry",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`entry` {ZipEntry}",
                      "name": "entry",
                      "type": "ZipEntry"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Promise} Fulfilled with `entry`.",
                    "name": "return",
                    "type": "Promise",
                    "desc": "Fulfilled with `entry`."
                  }
                }
              ],
              "desc": "<p>Writes <code>entry</code> where the central directory currently starts, then rewrites\nthe central directory to include it, replacing any existing entry of the\nsame name. Throws <a href=\"errors.html#err_zip_not_writable\"><code>ERR_ZIP_NOT_WRITABLE</code></a> if the <code>ZipFile</code> was not opened\nwith <code>{ writable: true }</code>.</p>\n<p>The returned (same) <code>entry</code> is left readable: a streaming entry created with\n<a href=\"#static-method-zlibzipentrycreatestreamfilename-source-options\"><code>zlib.ZipEntry.createStream()</code></a>, which would otherwise be spent once\nserialized, is promoted in place to a file-backed entry pointing at the copy\njust written (valid while this <code>ZipFile</code> is open). In-memory entries keep their\nown buffer unchanged.</p>"
            },
            {
              "textRaw": "`zipFile.addEntrySync(entry)`",
              "name": "addEntrySync",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`entry` {ZipEntry}",
                      "name": "entry",
                      "type": "ZipEntry"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {ZipEntry} `entry`.",
                    "name": "return",
                    "type": "ZipEntry",
                    "desc": "`entry`."
                  }
                }
              ],
              "desc": "<p>The synchronous version of <a href=\"#zipfileaddentryentry\"><code>zipFile.addEntry()</code></a>. <code>entry</code> must not be a\npending streaming entry (one created with\n<a href=\"#static-method-zlibzipentrycreatestreamfilename-source-options\"><code>zlib.ZipEntry.createStream()</code></a>) - there is no synchronous way to drain\nits asynchronous source.</p>"
            },
            {
              "textRaw": "`zipFile.addSync(filename, data[, options])`",
              "name": "addSync",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`filename` {string} The entry's name within the archive. A trailing `/` marks a directory entry.",
                      "name": "filename",
                      "type": "string",
                      "desc": "The entry's name within the archive. A trailing `/` marks a directory entry."
                    },
                    {
                      "textRaw": "`data` {Buffer|TypedArray|DataView|ArrayBuffer} The entry's complete, uncompressed content.",
                      "name": "data",
                      "type": "Buffer|TypedArray|DataView|ArrayBuffer",
                      "desc": "The entry's complete, uncompressed content."
                    },
                    {
                      "textRaw": "`options` {Object} See `zlib.ZipEntry.createSync()`.",
                      "name": "options",
                      "type": "Object",
                      "desc": "See `zlib.ZipEntry.createSync()`.",
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {ZipEntry} The created entry.",
                    "name": "return",
                    "type": "ZipEntry",
                    "desc": "The created entry."
                  }
                }
              ],
              "desc": "<p>The synchronous version of <a href=\"#zipfileaddfilename-data-options\"><code>zipFile.add()</code></a>. Equivalent to\n<code>zipFile.addEntrySync(zlib.ZipEntry.createSync(filename, data, options))</code>.</p>"
            },
            {
              "textRaw": "`zipFile.close()`",
              "name": "close",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [],
                  "return": {
                    "textRaw": "Returns: {Promise}",
                    "name": "return",
                    "type": "Promise"
                  }
                }
              ],
              "desc": "<p>Closes the underlying file handle.</p>\n<p>Closing does not invalidate outstanding objects: <code>ZipEntry</code> objects previously\nreturned by <a href=\"#zipfilegetname\"><code>zipFile.get()</code></a> and the <code>ZipFile</code>'s own methods will fail with\nsystem-level errors (for example <code>EBADF</code>) if used after close, rather than a\ndedicated Node.js error code. The same applies to <a href=\"#zipfileclosesync\"><code>zipFile.closeSync()</code></a>.</p>"
            },
            {
              "textRaw": "`zipFile.closeSync()`",
              "name": "closeSync",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": []
                }
              ],
              "desc": "<p>The synchronous version of <a href=\"#zipfileclose\"><code>zipFile.close()</code></a>.</p>"
            },
            {
              "textRaw": "`zipFile.compact([comment])`",
              "name": "compact",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`comment` {string} An archive comment. **Default:** `zipFile.comment`.",
                      "name": "comment",
                      "type": "string",
                      "default": "`zipFile.comment`",
                      "desc": "An archive comment.",
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {stream.Readable} A stream of the currently live entries, serialized as a fresh archive with no dead space left by prior `zipFile.addEntry()`/`zipFile.delete()` calls.",
                    "name": "return",
                    "type": "stream.Readable",
                    "desc": "A stream of the currently live entries, serialized as a fresh archive with no dead space left by prior `zipFile.addEntry()`/`zipFile.delete()` calls."
                  }
                }
              ],
              "desc": "<p>Does not modify the open file; pipe the result into a new one:</p>\n<pre><code class=\"language-mjs\">import { createWriteStream } from 'node:fs';\nzip.compact().pipe(createWriteStream('compacted.zip'));\n</code></pre>"
            },
            {
              "textRaw": "`zipFile.compactSync([comment])`",
              "name": "compactSync",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`comment` {string} An archive comment. **Default:** `zipFile.comment`.",
                      "name": "comment",
                      "type": "string",
                      "default": "`zipFile.comment`",
                      "desc": "An archive comment.",
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Buffer} The currently live entries, serialized as a fresh archive with no dead space left by prior `zipFile.addEntry()`/`zipFile.delete()` calls.",
                    "name": "return",
                    "type": "Buffer",
                    "desc": "The currently live entries, serialized as a fresh archive with no dead space left by prior `zipFile.addEntry()`/`zipFile.delete()` calls."
                  }
                }
              ],
              "desc": "<p>The synchronous version of <a href=\"#zipfilecompactcomment\"><code>zipFile.compact()</code></a>. Does not modify the\nopen file.</p>"
            },
            {
              "textRaw": "`zipFile.delete(name)`",
              "name": "delete",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`name` {string}",
                      "name": "name",
                      "type": "string"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Promise} Fulfilled with `true` if an entry named `name` existed and was removed, `false` otherwise.",
                    "name": "return",
                    "type": "Promise",
                    "desc": "Fulfilled with `true` if an entry named `name` existed and was removed, `false` otherwise."
                  }
                }
              ],
              "desc": "<p>Rewrites the central directory without writing any new content - the\narchive does not grow. Throws <a href=\"errors.html#err_zip_not_writable\"><code>ERR_ZIP_NOT_WRITABLE</code></a> if the <code>ZipFile</code> was\nnot opened with <code>{ writable: true }</code>.</p>"
            },
            {
              "textRaw": "`zipFile.deleteSync(name)`",
              "name": "deleteSync",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`name` {string}",
                      "name": "name",
                      "type": "string"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean} `true` if an entry named `name` existed and was removed, `false` otherwise.",
                    "name": "return",
                    "type": "boolean",
                    "desc": "`true` if an entry named `name` existed and was removed, `false` otherwise."
                  }
                }
              ],
              "desc": "<p>The synchronous version of <a href=\"#zipfiledeletename\"><code>zipFile.delete()</code></a>.</p>"
            },
            {
              "textRaw": "`zipFile.entries()`",
              "name": "entries",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [],
                  "return": {
                    "textRaw": "Returns: {Iterator} of `[name, entry]` pairs, where `entry` is a {Promise} fulfilled with a `ZipEntry`.",
                    "name": "return",
                    "type": "Iterator",
                    "desc": "of `[name, entry]` pairs, where `entry` is a {Promise} fulfilled with a `ZipEntry`."
                  }
                }
              ]
            },
            {
              "textRaw": "`zipFile.entriesSync()`",
              "name": "entriesSync",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [],
                  "return": {
                    "textRaw": "Returns: {Iterator} of `[name, entry]` pairs, where `entry` is a resolved `ZipEntry` (not a `Promise`).",
                    "name": "return",
                    "type": "Iterator",
                    "desc": "of `[name, entry]` pairs, where `entry` is a resolved `ZipEntry` (not a `Promise`)."
                  }
                }
              ],
              "desc": "<p>The synchronous version of <a href=\"#zipfileentries\"><code>zipFile.entries()</code></a>.</p>"
            },
            {
              "textRaw": "`zipFile.forEach(callback[, thisArg])`",
              "name": "forEach",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`callback` {Function}",
                      "name": "callback",
                      "type": "Function"
                    },
                    {
                      "textRaw": "`thisArg` {any}",
                      "name": "thisArg",
                      "type": "any",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "`zipFile.forEachSync(callback[, thisArg])`",
              "name": "forEachSync",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`callback` {Function}",
                      "name": "callback",
                      "type": "Function"
                    },
                    {
                      "textRaw": "`thisArg` {any}",
                      "name": "thisArg",
                      "type": "any",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "<p>The synchronous version of <a href=\"#zipfileforeachcallback-thisarg\"><code>zipFile.forEach()</code></a>: <code>callback</code> is invoked\nwith a resolved <a href=\"#class-zlibzipentry\"><code>ZipEntry</code></a> instead of a <code>Promise</code>.</p>"
            },
            {
              "textRaw": "`zipFile.get(name)`",
              "name": "get",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`name` {string}",
                      "name": "name",
                      "type": "string"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Promise} Fulfilled with a {ZipEntry}.",
                    "name": "return",
                    "type": "Promise",
                    "desc": "Fulfilled with a {ZipEntry}."
                  }
                }
              ],
              "desc": "<p>Returns a lazy, file-backed <a href=\"#class-zlibzipentry\"><code>ZipEntry</code></a> for <code>name</code>. Nothing is read from\ndisk here and no content is buffered: the returned entry reads (and, for\n<a href=\"#zipentrycontentoptions\"><code>zipEntry.content()</code></a>, decompresses) its member straight from the file on\neach access, and the <code>ZipFile</code> retains no member content. The entry is valid\nonly while this <code>ZipFile</code> is open. Reading its content later may throw\n<a href=\"errors.html#err_zip_entry_too_large\"><code>ERR_ZIP_ENTRY_TOO_LARGE</code></a> if the member is too large to hold in a single\nbuffer; use <a href=\"#zipentrycontentiteratoroptions\"><code>zipEntry.contentIterator()</code></a> (or <a href=\"#zipfilestreamname-options\"><code>zipFile.stream()</code></a>)\ninstead. Throws <a href=\"errors.html#err_zip_entry_not_found\"><code>ERR_ZIP_ENTRY_NOT_FOUND</code></a> if the archive has no entry\nnamed <code>name</code>.</p>"
            },
            {
              "textRaw": "`zipFile.getSync(name)`",
              "name": "getSync",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`name` {string}",
                      "name": "name",
                      "type": "string"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {ZipEntry}",
                    "name": "return",
                    "type": "ZipEntry"
                  }
                }
              ],
              "desc": "<p>The synchronous version of <a href=\"#zipfilegetname\"><code>zipFile.get()</code></a>. Like <code>get()</code>, it reads\nnothing up front and only builds the lazy handle, so it does not itself block\non I/O - but reads performed later through the returned entry (such as\n<a href=\"#zipentrycontentsyncoptions\"><code>zipEntry.contentSync()</code></a>) do; see the note above on synchronous methods.</p>"
            },
            {
              "textRaw": "`zipFile.has(name)`",
              "name": "has",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`name` {string}",
                      "name": "name",
                      "type": "string"
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {boolean}",
                    "name": "return",
                    "type": "boolean"
                  }
                }
              ]
            },
            {
              "textRaw": "`zipFile.keys()`",
              "name": "keys",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [],
                  "return": {
                    "textRaw": "Returns: {Iterator} of entry names.",
                    "name": "return",
                    "type": "Iterator",
                    "desc": "of entry names."
                  }
                }
              ]
            },
            {
              "textRaw": "`zipFile.stream(name[, options])`",
              "name": "stream",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`name` {string}",
                      "name": "name",
                      "type": "string"
                    },
                    {
                      "textRaw": "`options` {Object}",
                      "name": "options",
                      "type": "Object",
                      "options": [
                        {
                          "textRaw": "`verify` {boolean} Verify the entry's CRC-32 checksum. **Default:** `true`.",
                          "name": "verify",
                          "type": "boolean",
                          "default": "`true`",
                          "desc": "Verify the entry's CRC-32 checksum."
                        },
                        {
                          "textRaw": "`maxSize` {number} Reject content declaring more than this many uncompressed bytes. **Default:** no limit.",
                          "name": "maxSize",
                          "type": "number",
                          "default": "no limit",
                          "desc": "Reject content declaring more than this many uncompressed bytes."
                        }
                      ],
                      "optional": true
                    }
                  ],
                  "return": {
                    "textRaw": "Returns: {Promise} Fulfilled with a {stream.Readable} of the member's decompressed content, without buffering the whole member in memory.",
                    "name": "return",
                    "type": "Promise",
                    "desc": "Fulfilled with a {stream.Readable} of the member's decompressed content, without buffering the whole member in memory."
                  }
                }
              ],
              "desc": "<p>Convenience wrapper that resolves to a <code>Readable</code> over\n<a href=\"#zipentrycontentiteratoroptions\"><code>zipEntry.contentIterator()</code></a> of <a href=\"#zipfilegetname\"><code>zipFile.get()</code></a><code>(name)</code>; the\ncompressed bytes are read from disk as the stream is consumed. The returned\npromise rejects with <a href=\"errors.html#err_zip_entry_not_found\"><code>ERR_ZIP_ENTRY_NOT_FOUND</code></a> if the archive has no entry\nnamed <code>name</code>.</p>"
            },
            {
              "textRaw": "`zipFile.values()`",
              "name": "values",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [],
                  "return": {
                    "textRaw": "Returns: {Iterator} of {Promise} objects, each fulfilled with a `ZipEntry`.",
                    "name": "return",
                    "type": "Iterator",
                    "desc": "of {Promise} objects, each fulfilled with a `ZipEntry`."
                  }
                }
              ]
            },
            {
              "textRaw": "`zipFile.valuesSync()`",
              "name": "valuesSync",
              "type": "method",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [],
                  "return": {
                    "textRaw": "Returns: {Iterator} of resolved `ZipEntry` values (not `Promise`s).",
                    "name": "return",
                    "type": "Iterator",
                    "desc": "of resolved `ZipEntry` values (not `Promise`s)."
                  }
                }
              ],
              "desc": "<p>The synchronous version of <a href=\"#zipfilevalues\"><code>zipFile.values()</code></a>.</p>"
            }
          ],
          "properties": [
            {
              "textRaw": "Type: {string}",
              "name": "comment",
              "type": "string",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "desc": "<p>The archive-level comment, preserved byte-for-byte across\n<a href=\"#zipfileaddentryentry\"><code>zipFile.addEntry()</code></a>/<a href=\"#zipfiledeletename\"><code>zipFile.delete()</code></a> calls. The bytes are decoded\nas UTF-8 when they are valid UTF-8 and as CP437 otherwise (the field carries\nno encoding flag of its own).</p>"
            },
            {
              "textRaw": "Type: {number}",
              "name": "size",
              "type": "number",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "desc": "<p>The number of entries in the archive.</p>"
            },
            {
              "textRaw": "Type: {boolean}",
              "name": "writable",
              "type": "boolean",
              "meta": {
                "added": [
                  "v26.8.0"
                ],
                "changes": []
              },
              "desc": "<p>Whether this <code>ZipFile</code> was opened with <code>{ writable: true }</code>.</p>"
            }
          ]
        },
        {
          "textRaw": "Class: `zlib.ZlibBase`",
          "name": "zlib.ZlibBase",
          "type": "class",
          "meta": {
            "added": [
              "v0.5.8"
            ],
            "changes": [
              {
                "version": [
                  "v11.7.0",
                  "v10.16.0"
                ],
                "pr-url": "https://github.com/nodejs/node/pull/24939",
                "description": "This class was renamed from `Zlib` to `ZlibBase`."
              }
            ]
          },
          "desc": "<ul>\n<li>Extends: <a href=\"stream.html#class-streamtransform\"><code>stream.Transform</code></a></li>\n</ul>\n<p>Not exported by the <code>node:zlib</code> module. It is documented here because it is the\nbase class of the compressor/decompressor classes.</p>\n<p>This class inherits from <a href=\"stream.html#class-streamtransform\"><code>stream.Transform</code></a>, allowing <code>node:zlib</code> objects to\nbe used in pipes and similar stream operations.</p>",
          "properties": [
            {
              "textRaw": "Type: {number}",
              "name": "bytesWritten",
              "type": "number",
              "meta": {
                "added": [
                  "v10.0.0"
                ],
                "changes": []
              },
              "desc": "<p>The <code>zlib.bytesWritten</code> property specifies the number of bytes written to\nthe engine, before the bytes are processed (compressed or decompressed,\nas appropriate for the derived class).</p>"
            }
          ],
          "methods": [
            {
              "textRaw": "`zlib.close([callback])`",
              "name": "close",
              "type": "method",
              "meta": {
                "added": [
                  "v0.9.4"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`callback` {Function}",
                      "name": "callback",
                      "type": "Function",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "<p>Close the underlying handle.</p>"
            },
            {
              "textRaw": "`zlib.flush([kind, ]callback)`",
              "name": "flush",
              "type": "method",
              "meta": {
                "added": [
                  "v0.5.8"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "name": "kind",
                      "optional": true
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ],
              "desc": "<ul>\n<li><code>kind</code> <strong>Default:</strong> <code>zlib.constants.Z_FULL_FLUSH</code> for zlib-based streams,\n<code>zlib.constants.BROTLI_OPERATION_FLUSH</code> for Brotli-based streams.</li>\n<li><code>callback</code> <a href=\"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function\"><code>&#x3C;Function></code></a></li>\n</ul>\n<p>Flush pending data. Don't call this frivolously, premature flushes negatively\nimpact the effectiveness of the compression algorithm.</p>\n<p>Calling this only flushes data from the internal <code>zlib</code> state, and does not\nperform flushing of any kind on the streams level. Rather, it behaves like a\nnormal call to <code>.write()</code>, i.e. it will be queued up behind other pending\nwrites and will only produce output when data is being read from the stream.</p>"
            },
            {
              "textRaw": "`zlib.params(level, strategy, callback)`",
              "name": "params",
              "type": "method",
              "meta": {
                "added": [
                  "v0.11.4"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`level` {integer}",
                      "name": "level",
                      "type": "integer"
                    },
                    {
                      "textRaw": "`strategy` {integer}",
                      "name": "strategy",
                      "type": "integer"
                    },
                    {
                      "textRaw": "`callback` {Function}",
                      "name": "callback",
                      "type": "Function"
                    }
                  ]
                }
              ],
              "desc": "<p>This function is only available for zlib-based streams, i.e. not Brotli.</p>\n<p>Dynamically update the compression level and compression strategy.\nOnly applicable to deflate algorithm.</p>"
            },
            {
              "textRaw": "`zlib.reset()`",
              "name": "reset",
              "type": "method",
              "meta": {
                "added": [
                  "v0.7.0"
                ],
                "changes": []
              },
              "signatures": [
                {
                  "params": []
                }
              ],
              "desc": "<p>Reset the compressor/decompressor to factory defaults. Only applicable to\nthe inflate and deflate algorithms.</p>"
            }
          ]
        },
        {
          "textRaw": "Class: `zlib.ZstdCompress`",
          "name": "zlib.ZstdCompress",
          "type": "class",
          "meta": {
            "added": [
              "v23.8.0",
              "v22.15.0"
            ],
            "changes": []
          },
          "stability": 1,
          "stabilityText": "Experimental",
          "desc": "<p>Compress data using the Zstd algorithm.</p>"
        },
        {
          "textRaw": "Class: `zlib.ZstdDecompress`",
          "name": "zlib.ZstdDecompress",
          "type": "class",
          "meta": {
            "added": [
              "v23.8.0",
              "v22.15.0"
            ],
            "changes": []
          },
          "stability": 1,
          "stabilityText": "Experimental",
          "desc": "<p>Decompress data using the Zstd algorithm.</p>"
        }
      ],
      "properties": [
        {
          "textRaw": "`zlib.constants`",
          "name": "constants",
          "type": "property",
          "meta": {
            "added": [
              "v7.0.0"
            ],
            "changes": []
          },
          "desc": "<p>Provides an object enumerating Zlib-related constants.</p>"
        }
      ],
      "methods": [
        {
          "textRaw": "`zlib.crc32(data[, value])`",
          "name": "crc32",
          "type": "method",
          "meta": {
            "added": [
              "v22.2.0",
              "v20.15.0"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`data` {string|Buffer|TypedArray|DataView} When `data` is a string, it will be encoded as UTF-8 before being used for computation.",
                  "name": "data",
                  "type": "string|Buffer|TypedArray|DataView",
                  "desc": "When `data` is a string, it will be encoded as UTF-8 before being used for computation."
                },
                {
                  "textRaw": "`value` {integer} An optional starting value. It must be a 32-bit unsigned integer. **Default:** `0`",
                  "name": "value",
                  "type": "integer",
                  "default": "`0`",
                  "desc": "An optional starting value. It must be a 32-bit unsigned integer.",
                  "optional": true
                }
              ],
              "return": {
                "textRaw": "Returns: {integer} A 32-bit unsigned integer containing the checksum.",
                "name": "return",
                "type": "integer",
                "desc": "A 32-bit unsigned integer containing the checksum."
              }
            }
          ],
          "desc": "<p>Computes a 32-bit <a href=\"https://en.wikipedia.org/wiki/Cyclic_redundancy_check\">Cyclic Redundancy Check</a> checksum of <code>data</code>. If\n<code>value</code> is specified, it is used as the starting value of the checksum,\notherwise, 0 is used as the starting value.</p>\n<p>The CRC algorithm is designed to compute checksums and to detect error\nin data transmission. It's not suitable for cryptographic authentication.</p>\n<p>To be consistent with other APIs, if the <code>data</code> is a string, it will\nbe encoded with UTF-8 before being used for computation. If users only\nuse Node.js to compute and match the checksums, this works well with\nother APIs that uses the UTF-8 encoding by default.</p>\n<p>Some third-party JavaScript libraries compute the checksum on a\nstring based on <code>str.charCodeAt()</code> so that it can be run in browsers.\nIf users want to match the checksum computed with this kind of library\nin the browser, it's better to use the same library in Node.js\nif it also runs in Node.js. If users have to use <code>zlib.crc32()</code> to\nmatch the checksum produced by such a third-party library:</p>\n<ol>\n<li>If the library accepts <code>Uint8Array</code> as input, use <code>TextEncoder</code>\nin the browser to encode the string into a <code>Uint8Array</code> with UTF-8\nencoding, and compute the checksum based on the UTF-8 encoded string\nin the browser.</li>\n<li>If the library only takes a string and compute the data based on\n<code>str.charCodeAt()</code>, on the Node.js side, convert the string into\na buffer using <code>Buffer.from(str, 'utf16le')</code>.</li>\n</ol>\n<pre><code class=\"language-mjs\">import zlib from 'node:zlib';\nimport { Buffer } from 'node:buffer';\n\nlet crc = zlib.crc32('hello');  // 907060870\ncrc = zlib.crc32('world', crc);  // 4192936109\n\ncrc = zlib.crc32(Buffer.from('hello', 'utf16le'));  // 1427272415\ncrc = zlib.crc32(Buffer.from('world', 'utf16le'), crc);  // 4150509955\n</code></pre>\n<pre><code class=\"language-cjs\">const zlib = require('node:zlib');\nconst { Buffer } = require('node:buffer');\n\nlet crc = zlib.crc32('hello');  // 907060870\ncrc = zlib.crc32('world', crc);  // 4192936109\n\ncrc = zlib.crc32(Buffer.from('hello', 'utf16le'));  // 1427272415\ncrc = zlib.crc32(Buffer.from('world', 'utf16le'), crc);  // 4150509955\n</code></pre>"
        },
        {
          "textRaw": "`zlib.createBrotliCompress([options])`",
          "name": "createBrotliCompress",
          "type": "method",
          "meta": {
            "added": [
              "v11.7.0",
              "v10.16.0"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`options` {brotli options}",
                  "name": "options",
                  "type": "brotli options",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>Creates and returns a new <a href=\"#class-zlibbrotlicompress\"><code>BrotliCompress</code></a> object.</p>"
        },
        {
          "textRaw": "`zlib.createBrotliDecompress([options])`",
          "name": "createBrotliDecompress",
          "type": "method",
          "meta": {
            "added": [
              "v11.7.0",
              "v10.16.0"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`options` {brotli options}",
                  "name": "options",
                  "type": "brotli options",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>Creates and returns a new <a href=\"#class-zlibbrotlidecompress\"><code>BrotliDecompress</code></a> object.</p>"
        },
        {
          "textRaw": "`zlib.createDeflate([options])`",
          "name": "createDeflate",
          "type": "method",
          "meta": {
            "added": [
              "v0.5.8"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`options` {zlib options}",
                  "name": "options",
                  "type": "zlib options",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>Creates and returns a new <a href=\"#class-zlibdeflate\"><code>Deflate</code></a> object.</p>"
        },
        {
          "textRaw": "`zlib.createDeflateRaw([options])`",
          "name": "createDeflateRaw",
          "type": "method",
          "meta": {
            "added": [
              "v0.5.8"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`options` {zlib options}",
                  "name": "options",
                  "type": "zlib options",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>Creates and returns a new <a href=\"#class-zlibdeflateraw\"><code>DeflateRaw</code></a> object.</p>\n<p>An upgrade of zlib from 1.2.8 to 1.2.11 changed behavior when <code>windowBits</code>\nis set to 8 for raw deflate streams. zlib would automatically set <code>windowBits</code>\nto 9 if was initially set to 8. Newer versions of zlib will throw an exception,\nso Node.js restored the original behavior of upgrading a value of 8 to 9,\nsince passing <code>windowBits = 9</code> to zlib actually results in a compressed stream\nthat effectively uses an 8-bit window only.</p>"
        },
        {
          "textRaw": "`zlib.createGunzip([options])`",
          "name": "createGunzip",
          "type": "method",
          "meta": {
            "added": [
              "v0.5.8"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`options` {zlib options}",
                  "name": "options",
                  "type": "zlib options",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>Creates and returns a new <a href=\"#class-zlibgunzip\"><code>Gunzip</code></a> object.</p>"
        },
        {
          "textRaw": "`zlib.createGzip([options])`",
          "name": "createGzip",
          "type": "method",
          "meta": {
            "added": [
              "v0.5.8"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`options` {zlib options}",
                  "name": "options",
                  "type": "zlib options",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>Creates and returns a new <a href=\"#class-zlibgzip\"><code>Gzip</code></a> object.\nSee <a href=\"#zlib\">example</a>.</p>"
        },
        {
          "textRaw": "`zlib.createInflate([options])`",
          "name": "createInflate",
          "type": "method",
          "meta": {
            "added": [
              "v0.5.8"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`options` {zlib options}",
                  "name": "options",
                  "type": "zlib options",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>Creates and returns a new <a href=\"#class-zlibinflate\"><code>Inflate</code></a> object.</p>"
        },
        {
          "textRaw": "`zlib.createInflateRaw([options])`",
          "name": "createInflateRaw",
          "type": "method",
          "meta": {
            "added": [
              "v0.5.8"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`options` {zlib options}",
                  "name": "options",
                  "type": "zlib options",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>Creates and returns a new <a href=\"#class-zlibinflateraw\"><code>InflateRaw</code></a> object.</p>"
        },
        {
          "textRaw": "`zlib.createUnzip([options])`",
          "name": "createUnzip",
          "type": "method",
          "meta": {
            "added": [
              "v0.5.8"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`options` {zlib options}",
                  "name": "options",
                  "type": "zlib options",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>Creates and returns a new <a href=\"#class-zlibunzip\"><code>Unzip</code></a> object.</p>"
        },
        {
          "textRaw": "`zlib.createZipArchive(entries[, options])`",
          "name": "createZipArchive",
          "type": "method",
          "meta": {
            "added": [
              "v26.8.0"
            ],
            "changes": []
          },
          "stability": 1,
          "stabilityText": "Early development",
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`entries` {Iterable|AsyncIterable} of `ZipEntry`.",
                  "name": "entries",
                  "type": "Iterable|AsyncIterable",
                  "desc": "of `ZipEntry`."
                },
                {
                  "textRaw": "`options` {string|Object} An archive comment, as a shorthand for `{ comment: options }`.",
                  "name": "options",
                  "type": "string|Object",
                  "desc": "An archive comment, as a shorthand for `{ comment: options }`.",
                  "options": [
                    {
                      "textRaw": "`comment` {string} An archive comment.",
                      "name": "comment",
                      "type": "string",
                      "desc": "An archive comment."
                    },
                    {
                      "textRaw": "`baseOffset` {number} Shifts every local/central header offset the archive records by this many bytes, so the emitted stream is self-describing even when something else is written before it - for example, appending the archive after `baseOffset` bytes already written to the same file, rather than at its start. **Default:** `0`.",
                      "name": "baseOffset",
                      "type": "number",
                      "default": "`0`",
                      "desc": "Shifts every local/central header offset the archive records by this many bytes, so the emitted stream is self-describing even when something else is written before it - for example, appending the archive after `baseOffset` bytes already written to the same file, rather than at its start."
                    }
                  ],
                  "optional": true
                }
              ],
              "return": {
                "textRaw": "Returns: {stream.Readable} A byte stream of the serialized archive.",
                "name": "return",
                "type": "stream.Readable",
                "desc": "A byte stream of the serialized archive."
              }
            }
          ],
          "desc": "<p>The ZIP archive API is experimental. Using any part of it (this function among\nthem) emits an experimental warning the first time; merely importing\n<code>node:zlib</code> does not.</p>\n<p>Serializes <code>entries</code> into a ZIP archive, switching to Zip64 structures\nautomatically once the entry count, or any offset or size, exceeds what the\nclassic 32-/16-bit ZIP fields can hold. The returned <code>Readable</code> is also an\n<code>AsyncIterable</code> of the same <a href=\"buffer.html#class-buffer\"><code>&#x3C;Buffer></code></a> chunks it streams.</p>\n<p>Entries are written in iteration order and nothing deduplicates names: an\niterable that yields two entries with the same name produces an archive\ncontaining both, and most extraction tools keep the one that appears later.\n<a href=\"#class-zlibzipbuffer\"><code>ZipBuffer</code></a> and <a href=\"#class-zlibzipfile\"><code>ZipFile</code></a> <code>add()</code> methods replace entries by name\ninstead.</p>\n<p>The entries are owned by the returned stream: each is consumed as the archive\nis produced and must not be reused afterwards. This matters for streaming\nentries (from <a href=\"#static-method-zlibzipentrycreatestreamfilename-source-options\"><code>zlib.ZipEntry.createStream()</code></a>), which hold an underlying\nsource such as a file read stream. If the returned stream is destroyed before\nit is fully consumed - for example, the destination of a <a href=\"stream.html#streampipelinesource-transforms-destination-callback\"><code>pipeline()</code></a>\nfails - it disposes the entry it was serializing and every entry still queued\nbehind it, destroying their sources so no descriptor leaks. Consume the stream\nto the end, or destroy it (directly, through a failed <code>pipeline()</code>, or with\n<code>await using</code>), to guarantee this cleanup; a stream that is neither consumed\nnor destroyed cannot release anything. A <a href=\"#class-zlibzipentry\"><code>ZipEntry</code></a> that is never handed to\nan archive can be released directly with <code>Symbol.dispose</code> / <code>Symbol.asyncDispose</code>.</p>\n<p>Throws an <a href=\"errors.html#err_zip_archive_too_large\"><code>ERR_ZIP_ARCHIVE_TOO_LARGE</code></a> error if the archive comment\nexceeds 65,535 bytes when encoded as UTF-8.</p>\n<pre><code class=\"language-mjs\">import { createWriteStream } from 'node:fs';\nimport { pipeline } from 'node:stream/promises';\nimport { Buffer } from 'node:buffer';\nimport { ZipEntry, createZipArchive } from 'node:zlib';\n\nconst entries = [\n  await ZipEntry.create('hello.txt', Buffer.from('Hello, world!')),\n  await ZipEntry.create('data/', Buffer.alloc(0)),\n];\nawait pipeline(\n  createZipArchive(entries, 'created by node:zlib'),\n  createWriteStream('archive.zip'),\n);\n</code></pre>\n<pre><code class=\"language-cjs\">const { createWriteStream } = require('node:fs');\nconst { pipeline } = require('node:stream/promises');\nconst { ZipEntry, createZipArchive } = require('node:zlib');\n\nasync function main() {\n  const entries = [\n    await ZipEntry.create('hello.txt', Buffer.from('Hello, world!')),\n    await ZipEntry.create('data/', Buffer.alloc(0)),\n  ];\n  await pipeline(\n    createZipArchive(entries, 'created by node:zlib'),\n    createWriteStream('archive.zip'),\n  );\n}\nmain();\n</code></pre>\n<p>Passing <code>options.baseOffset</code> produces an archive that is valid immediately\nwhen placed after other content in the same file, without relying on a\nreader's self-extracting-archive detection to compensate for the shift:</p>\n<pre><code class=\"language-mjs\">import { createWriteStream } from 'node:fs';\nimport { Buffer } from 'node:buffer';\nimport { ZipEntry, createZipArchive } from 'node:zlib';\n\nconst prefix = Buffer.from('#!/bin/sh\\nexit 0\\n');\nconst entries = [await ZipEntry.create('hello.txt', Buffer.from('Hello, world!'))];\nconst out = createWriteStream('self-extracting.zip');\nout.write(prefix);\ncreateZipArchive(entries, { baseOffset: prefix.byteLength }).pipe(out);\n</code></pre>"
        },
        {
          "textRaw": "`zlib.createZipArchiveSync(entries[, options])`",
          "name": "createZipArchiveSync",
          "type": "method",
          "meta": {
            "added": [
              "v26.8.0"
            ],
            "changes": []
          },
          "stability": 1,
          "stabilityText": "Early development",
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`entries` {Iterable} of `ZipEntry`.",
                  "name": "entries",
                  "type": "Iterable",
                  "desc": "of `ZipEntry`."
                },
                {
                  "textRaw": "`options` {string|Object} See `zlib.createZipArchive()`.",
                  "name": "options",
                  "type": "string|Object",
                  "desc": "See `zlib.createZipArchive()`.",
                  "optional": true
                }
              ],
              "return": {
                "textRaw": "Returns: {Iterator} of {Buffer} chunks making up the serialized archive.",
                "name": "return",
                "type": "Iterator",
                "desc": "of {Buffer} chunks making up the serialized archive."
              }
            }
          ],
          "desc": "<p>The ZIP archive API is experimental. Using any part of it (this function among\nthem) emits an experimental warning the first time; merely importing\n<code>node:zlib</code> does not.</p>\n<p>The synchronous version of <a href=\"#zlibcreateziparchiveentries-options\"><code>zlib.createZipArchive()</code></a>. Blocks the\nNode.js event loop and further JavaScript execution until the whole\narchive (including any deflate passes) has been produced; use only where\nsynchronous execution is appropriate (for example, short-lived scripts or\nstartup code), not in code that must stay responsive. <code>entries</code> must be a\nplain (synchronous) <code>Iterable</code> - a streaming entry created with\n<a href=\"#static-method-zlibzipentrycreatestreamfilename-source-options\"><code>zlib.ZipEntry.createStream()</code></a> throws when its turn to serialize comes\nup, since draining its asynchronous source has no synchronous equivalent.</p>\n<p>As with <a href=\"#zlibcreateziparchiveentries-options\"><code>zlib.createZipArchive()</code></a>, the entries are owned by the returned\niterator and must not be reused. If iteration stops early - including the\nthrow on a streaming entry - the entry that stopped it and every entry still\nqueued behind it are disposed, releasing any sources they hold.</p>"
        },
        {
          "textRaw": "`zlib.zipFiles(files[, options])`",
          "name": "zipFiles",
          "type": "method",
          "meta": {
            "added": [
              "v26.8.0"
            ],
            "changes": []
          },
          "stability": 1,
          "stabilityText": "Early development",
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`files` {Iterable} of `[sourcePath, entryName]` string pairs. Any iterable works — an array, a `Map`, the result of `Object.entries()`, a generator.",
                  "name": "files",
                  "type": "Iterable",
                  "desc": "of `[sourcePath, entryName]` string pairs. Any iterable works — an array, a `Map`, the result of `Object.entries()`, a generator."
                },
                {
                  "textRaw": "`options` {string|Object}",
                  "name": "options",
                  "type": "string|Object",
                  "options": [
                    {
                      "textRaw": "`followSymlinks` {boolean} Resolve a symbolic link and archive the file it points to, rather than storing the link itself. **Default:** `true`.",
                      "name": "followSymlinks",
                      "type": "boolean",
                      "default": "`true`",
                      "desc": "Resolve a symbolic link and archive the file it points to, rather than storing the link itself."
                    },
                    {
                      "textRaw": "`comment` {string} An archive comment; a string `options` is shorthand for `{ comment: options }`.",
                      "name": "comment",
                      "type": "string",
                      "desc": "An archive comment; a string `options` is shorthand for `{ comment: options }`."
                    },
                    {
                      "textRaw": "`baseOffset` {number} See `zlib.createZipArchive()`.",
                      "name": "baseOffset",
                      "type": "number",
                      "desc": "See `zlib.createZipArchive()`."
                    }
                  ],
                  "optional": true
                }
              ],
              "return": {
                "textRaw": "Returns: {stream.Readable} of {Buffer} chunks making up the serialized archive.",
                "name": "return",
                "type": "stream.Readable",
                "desc": "of {Buffer} chunks making up the serialized archive."
              }
            }
          ],
          "desc": "<p>The ZIP archive API is experimental. Using any part of it (this function among\nthem) emits an experimental warning the first time; merely importing\n<code>node:zlib</code> does not.</p>\n<p>Builds an archive from files on disk. For each <code>[sourcePath, entryName]</code> pair\nit reads <code>sourcePath</code> and adds an entry named <code>entryName</code>, capturing the file's\nUnix mode and modification time. A directory becomes a directory entry; a\nregular file's contents are streamed in (as a <a href=\"#static-method-zlibzipentrycreatestreamfilename-source-options\"><code>zlib.ZipEntry.createStream()</code></a>\nentry) without being buffered in memory. Directory contents are not walked\nrecursively — list each path you want included.</p>\n<p>When <code>followSymlinks</code> is <code>true</code> (the default) a symbolic link is resolved and\narchived as its target file; when it is <code>false</code> the link itself is stored as a\nsymbolic-link entry whose content is the target path (see\n<a href=\"#static-method-zlibzipentrycreatesymlinkfilename-target-options\"><code>zlib.ZipEntry.createSymlink()</code></a>).</p>\n<pre><code class=\"language-mjs\">import { zipFiles } from 'node:zlib';\nimport { createWriteStream } from 'node:fs';\nimport { pipeline } from 'node:stream/promises';\n\nawait pipeline(\n  zipFiles([\n    ['/data/report.pdf', 'report.pdf'],\n    ['/data/notes.txt', 'docs/notes.txt'],\n  ]),\n  createWriteStream('archive.zip'),\n);\n</code></pre>"
        },
        {
          "textRaw": "`zlib.createZstdCompress([options])`",
          "name": "createZstdCompress",
          "type": "method",
          "meta": {
            "added": [
              "v23.8.0",
              "v22.15.0"
            ],
            "changes": []
          },
          "stability": 1,
          "stabilityText": "Experimental",
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`options` {zstd options}",
                  "name": "options",
                  "type": "zstd options",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>Creates and returns a new <a href=\"#class-zlibzstdcompress\"><code>ZstdCompress</code></a> object.</p>"
        },
        {
          "textRaw": "`zlib.createZstdDecompress([options])`",
          "name": "createZstdDecompress",
          "type": "method",
          "meta": {
            "added": [
              "v23.8.0",
              "v22.15.0"
            ],
            "changes": []
          },
          "stability": 1,
          "stabilityText": "Experimental",
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`options` {zstd options}",
                  "name": "options",
                  "type": "zstd options",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>Creates and returns a new <a href=\"#class-zlibzstddecompress\"><code>ZstdDecompress</code></a> object.</p>"
        },
        {
          "textRaw": "`zlib.getMaxZipContentSize()`",
          "name": "getMaxZipContentSize",
          "type": "method",
          "meta": {
            "added": [
              "v26.8.0"
            ],
            "changes": []
          },
          "stability": 1,
          "stabilityText": "Early development",
          "signatures": [
            {
              "params": [],
              "return": {
                "textRaw": "Returns: {number}",
                "name": "return",
                "type": "number"
              }
            }
          ],
          "desc": "<p>The ZIP archive API is experimental. Using any part of it (this function among\nthem) emits an experimental warning the first time; merely importing\n<code>node:zlib</code> does not.</p>\n<p>The current default ceiling, in bytes, applied by <a href=\"#zipentrycontentoptions\"><code>zipEntry.content()</code></a>\nwhen no explicit <code>maxSize</code> is given. <strong>Default:</strong> <code>268435456</code> (256 MiB).</p>"
        },
        {
          "textRaw": "`zlib.setMaxZipContentSize(size)`",
          "name": "setMaxZipContentSize",
          "type": "method",
          "meta": {
            "added": [
              "v26.8.0"
            ],
            "changes": []
          },
          "stability": 1,
          "stabilityText": "Early development",
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`size` {number}",
                  "name": "size",
                  "type": "number"
                }
              ]
            }
          ],
          "desc": "<p>The ZIP archive API is experimental. Using any part of it (this function among\nthem) emits an experimental warning the first time; merely importing\n<code>node:zlib</code> does not.</p>\n<p>Sets the default ceiling used by <a href=\"#zipentrycontentoptions\"><code>zipEntry.content()</code></a> when no explicit\n<code>maxSize</code> option is given. This is a guard against zip bombs: an archive\nwhose central directory declares a member larger than this is rejected\nbefore allocating memory for it. Streaming reads\n(<a href=\"#zipentrycontentiteratoroptions\"><code>zipEntry.contentIterator()</code></a>, <a href=\"#zipfilestreamname-options\"><code>zipFile.stream()</code></a>) are bounded-memory\nby design and are not affected by this setting.</p>"
        },
        {
          "textRaw": "`zlib.brotliCompress(buffer[, options], callback)`",
          "name": "brotliCompress",
          "type": "method",
          "meta": {
            "added": [
              "v11.7.0",
              "v10.16.0"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                  "name": "buffer",
                  "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                },
                {
                  "textRaw": "`options` {brotli options}",
                  "name": "options",
                  "type": "brotli options",
                  "optional": true
                },
                {
                  "textRaw": "`callback` {Function}",
                  "name": "callback",
                  "type": "Function"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "`zlib.brotliCompressSync(buffer[, options])`",
          "name": "brotliCompressSync",
          "type": "method",
          "meta": {
            "added": [
              "v11.7.0",
              "v10.16.0"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                  "name": "buffer",
                  "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                },
                {
                  "textRaw": "`options` {brotli options}",
                  "name": "options",
                  "type": "brotli options",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>Compress a chunk of data with <a href=\"#class-zlibbrotlicompress\"><code>BrotliCompress</code></a>.</p>"
        },
        {
          "textRaw": "`zlib.brotliDecompress(buffer[, options], callback)`",
          "name": "brotliDecompress",
          "type": "method",
          "meta": {
            "added": [
              "v11.7.0",
              "v10.16.0"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                  "name": "buffer",
                  "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                },
                {
                  "textRaw": "`options` {brotli options}",
                  "name": "options",
                  "type": "brotli options",
                  "optional": true
                },
                {
                  "textRaw": "`callback` {Function}",
                  "name": "callback",
                  "type": "Function"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "`zlib.brotliDecompressSync(buffer[, options])`",
          "name": "brotliDecompressSync",
          "type": "method",
          "meta": {
            "added": [
              "v11.7.0",
              "v10.16.0"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                  "name": "buffer",
                  "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                },
                {
                  "textRaw": "`options` {brotli options}",
                  "name": "options",
                  "type": "brotli options",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>Decompress a chunk of data with <a href=\"#class-zlibbrotlidecompress\"><code>BrotliDecompress</code></a>.</p>"
        },
        {
          "textRaw": "`zlib.deflate(buffer[, options], callback)`",
          "name": "deflate",
          "type": "method",
          "meta": {
            "added": [
              "v0.6.0"
            ],
            "changes": [
              {
                "version": "v9.4.0",
                "pr-url": "https://github.com/nodejs/node/pull/16042",
                "description": "The `buffer` parameter can be an `ArrayBuffer`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12223",
                "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12001",
                "description": "The `buffer` parameter can be an `Uint8Array` now."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                  "name": "buffer",
                  "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                },
                {
                  "textRaw": "`options` {zlib options}",
                  "name": "options",
                  "type": "zlib options",
                  "optional": true
                },
                {
                  "textRaw": "`callback` {Function}",
                  "name": "callback",
                  "type": "Function"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "`zlib.deflateSync(buffer[, options])`",
          "name": "deflateSync",
          "type": "method",
          "meta": {
            "added": [
              "v0.11.12"
            ],
            "changes": [
              {
                "version": "v9.4.0",
                "pr-url": "https://github.com/nodejs/node/pull/16042",
                "description": "The `buffer` parameter can be an `ArrayBuffer`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12223",
                "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12001",
                "description": "The `buffer` parameter can be an `Uint8Array` now."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                  "name": "buffer",
                  "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                },
                {
                  "textRaw": "`options` {zlib options}",
                  "name": "options",
                  "type": "zlib options",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>Compress a chunk of data with <a href=\"#class-zlibdeflate\"><code>Deflate</code></a>.</p>"
        },
        {
          "textRaw": "`zlib.deflateRaw(buffer[, options], callback)`",
          "name": "deflateRaw",
          "type": "method",
          "meta": {
            "added": [
              "v0.6.0"
            ],
            "changes": [
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12223",
                "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12001",
                "description": "The `buffer` parameter can be an `Uint8Array` now."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                  "name": "buffer",
                  "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                },
                {
                  "textRaw": "`options` {zlib options}",
                  "name": "options",
                  "type": "zlib options",
                  "optional": true
                },
                {
                  "textRaw": "`callback` {Function}",
                  "name": "callback",
                  "type": "Function"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "`zlib.deflateRawSync(buffer[, options])`",
          "name": "deflateRawSync",
          "type": "method",
          "meta": {
            "added": [
              "v0.11.12"
            ],
            "changes": [
              {
                "version": "v9.4.0",
                "pr-url": "https://github.com/nodejs/node/pull/16042",
                "description": "The `buffer` parameter can be an `ArrayBuffer`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12223",
                "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12001",
                "description": "The `buffer` parameter can be an `Uint8Array` now."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                  "name": "buffer",
                  "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                },
                {
                  "textRaw": "`options` {zlib options}",
                  "name": "options",
                  "type": "zlib options",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>Compress a chunk of data with <a href=\"#class-zlibdeflateraw\"><code>DeflateRaw</code></a>.</p>"
        },
        {
          "textRaw": "`zlib.gunzip(buffer[, options], callback)`",
          "name": "gunzip",
          "type": "method",
          "meta": {
            "added": [
              "v0.6.0"
            ],
            "changes": [
              {
                "version": "v9.4.0",
                "pr-url": "https://github.com/nodejs/node/pull/16042",
                "description": "The `buffer` parameter can be an `ArrayBuffer`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12223",
                "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12001",
                "description": "The `buffer` parameter can be an `Uint8Array` now."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                  "name": "buffer",
                  "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                },
                {
                  "textRaw": "`options` {zlib options}",
                  "name": "options",
                  "type": "zlib options",
                  "optional": true
                },
                {
                  "textRaw": "`callback` {Function}",
                  "name": "callback",
                  "type": "Function"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "`zlib.gunzipSync(buffer[, options])`",
          "name": "gunzipSync",
          "type": "method",
          "meta": {
            "added": [
              "v0.11.12"
            ],
            "changes": [
              {
                "version": "v9.4.0",
                "pr-url": "https://github.com/nodejs/node/pull/16042",
                "description": "The `buffer` parameter can be an `ArrayBuffer`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12223",
                "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12001",
                "description": "The `buffer` parameter can be an `Uint8Array` now."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                  "name": "buffer",
                  "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                },
                {
                  "textRaw": "`options` {zlib options}",
                  "name": "options",
                  "type": "zlib options",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>Decompress a chunk of data with <a href=\"#class-zlibgunzip\"><code>Gunzip</code></a>.</p>"
        },
        {
          "textRaw": "`zlib.gzip(buffer[, options], callback)`",
          "name": "gzip",
          "type": "method",
          "meta": {
            "added": [
              "v0.6.0"
            ],
            "changes": [
              {
                "version": "v9.4.0",
                "pr-url": "https://github.com/nodejs/node/pull/16042",
                "description": "The `buffer` parameter can be an `ArrayBuffer`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12223",
                "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12001",
                "description": "The `buffer` parameter can be an `Uint8Array` now."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                  "name": "buffer",
                  "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                },
                {
                  "textRaw": "`options` {zlib options}",
                  "name": "options",
                  "type": "zlib options",
                  "optional": true
                },
                {
                  "textRaw": "`callback` {Function}",
                  "name": "callback",
                  "type": "Function"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "`zlib.gzipSync(buffer[, options])`",
          "name": "gzipSync",
          "type": "method",
          "meta": {
            "added": [
              "v0.11.12"
            ],
            "changes": [
              {
                "version": "v9.4.0",
                "pr-url": "https://github.com/nodejs/node/pull/16042",
                "description": "The `buffer` parameter can be an `ArrayBuffer`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12223",
                "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12001",
                "description": "The `buffer` parameter can be an `Uint8Array` now."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                  "name": "buffer",
                  "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                },
                {
                  "textRaw": "`options` {zlib options}",
                  "name": "options",
                  "type": "zlib options",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>Compress a chunk of data with <a href=\"#class-zlibgzip\"><code>Gzip</code></a>.</p>"
        },
        {
          "textRaw": "`zlib.inflate(buffer[, options], callback)`",
          "name": "inflate",
          "type": "method",
          "meta": {
            "added": [
              "v0.6.0"
            ],
            "changes": [
              {
                "version": "v9.4.0",
                "pr-url": "https://github.com/nodejs/node/pull/16042",
                "description": "The `buffer` parameter can be an `ArrayBuffer`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12223",
                "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12001",
                "description": "The `buffer` parameter can be an `Uint8Array` now."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                  "name": "buffer",
                  "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                },
                {
                  "textRaw": "`options` {zlib options}",
                  "name": "options",
                  "type": "zlib options",
                  "optional": true
                },
                {
                  "textRaw": "`callback` {Function}",
                  "name": "callback",
                  "type": "Function"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "`zlib.inflateSync(buffer[, options])`",
          "name": "inflateSync",
          "type": "method",
          "meta": {
            "added": [
              "v0.11.12"
            ],
            "changes": [
              {
                "version": "v9.4.0",
                "pr-url": "https://github.com/nodejs/node/pull/16042",
                "description": "The `buffer` parameter can be an `ArrayBuffer`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12223",
                "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12001",
                "description": "The `buffer` parameter can be an `Uint8Array` now."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                  "name": "buffer",
                  "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                },
                {
                  "textRaw": "`options` {zlib options}",
                  "name": "options",
                  "type": "zlib options",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>Decompress a chunk of data with <a href=\"#class-zlibinflate\"><code>Inflate</code></a>.</p>"
        },
        {
          "textRaw": "`zlib.inflateRaw(buffer[, options], callback)`",
          "name": "inflateRaw",
          "type": "method",
          "meta": {
            "added": [
              "v0.6.0"
            ],
            "changes": [
              {
                "version": "v9.4.0",
                "pr-url": "https://github.com/nodejs/node/pull/16042",
                "description": "The `buffer` parameter can be an `ArrayBuffer`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12223",
                "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12001",
                "description": "The `buffer` parameter can be an `Uint8Array` now."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                  "name": "buffer",
                  "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                },
                {
                  "textRaw": "`options` {zlib options}",
                  "name": "options",
                  "type": "zlib options",
                  "optional": true
                },
                {
                  "textRaw": "`callback` {Function}",
                  "name": "callback",
                  "type": "Function"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "`zlib.inflateRawSync(buffer[, options])`",
          "name": "inflateRawSync",
          "type": "method",
          "meta": {
            "added": [
              "v0.11.12"
            ],
            "changes": [
              {
                "version": "v9.4.0",
                "pr-url": "https://github.com/nodejs/node/pull/16042",
                "description": "The `buffer` parameter can be an `ArrayBuffer`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12223",
                "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12001",
                "description": "The `buffer` parameter can be an `Uint8Array` now."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                  "name": "buffer",
                  "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                },
                {
                  "textRaw": "`options` {zlib options}",
                  "name": "options",
                  "type": "zlib options",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>Decompress a chunk of data with <a href=\"#class-zlibinflateraw\"><code>InflateRaw</code></a>.</p>"
        },
        {
          "textRaw": "`zlib.unzip(buffer[, options], callback)`",
          "name": "unzip",
          "type": "method",
          "meta": {
            "added": [
              "v0.6.0"
            ],
            "changes": [
              {
                "version": "v9.4.0",
                "pr-url": "https://github.com/nodejs/node/pull/16042",
                "description": "The `buffer` parameter can be an `ArrayBuffer`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12223",
                "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12001",
                "description": "The `buffer` parameter can be an `Uint8Array` now."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                  "name": "buffer",
                  "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                },
                {
                  "textRaw": "`options` {zlib options}",
                  "name": "options",
                  "type": "zlib options",
                  "optional": true
                },
                {
                  "textRaw": "`callback` {Function}",
                  "name": "callback",
                  "type": "Function"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "`zlib.unzipSync(buffer[, options])`",
          "name": "unzipSync",
          "type": "method",
          "meta": {
            "added": [
              "v0.11.12"
            ],
            "changes": [
              {
                "version": "v9.4.0",
                "pr-url": "https://github.com/nodejs/node/pull/16042",
                "description": "The `buffer` parameter can be an `ArrayBuffer`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12223",
                "description": "The `buffer` parameter can be any `TypedArray` or `DataView`."
              },
              {
                "version": "v8.0.0",
                "pr-url": "https://github.com/nodejs/node/pull/12001",
                "description": "The `buffer` parameter can be an `Uint8Array` now."
              }
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                  "name": "buffer",
                  "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                },
                {
                  "textRaw": "`options` {zlib options}",
                  "name": "options",
                  "type": "zlib options",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>Decompress a chunk of data with <a href=\"#class-zlibunzip\"><code>Unzip</code></a>.</p>"
        },
        {
          "textRaw": "`zlib.zstdCompress(buffer[, options], callback)`",
          "name": "zstdCompress",
          "type": "method",
          "meta": {
            "added": [
              "v23.8.0",
              "v22.15.0"
            ],
            "changes": []
          },
          "stability": 1,
          "stabilityText": "Experimental",
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                  "name": "buffer",
                  "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                },
                {
                  "textRaw": "`options` {zstd options}",
                  "name": "options",
                  "type": "zstd options",
                  "optional": true
                },
                {
                  "textRaw": "`callback` {Function}",
                  "name": "callback",
                  "type": "Function"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "`zlib.zstdCompressSync(buffer[, options])`",
          "name": "zstdCompressSync",
          "type": "method",
          "meta": {
            "added": [
              "v23.8.0",
              "v22.15.0"
            ],
            "changes": []
          },
          "stability": 1,
          "stabilityText": "Experimental",
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                  "name": "buffer",
                  "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                },
                {
                  "textRaw": "`options` {zstd options}",
                  "name": "options",
                  "type": "zstd options",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>Compress a chunk of data with <a href=\"#class-zlibzstdcompress\"><code>ZstdCompress</code></a>.</p>"
        },
        {
          "textRaw": "`zlib.zstdDecompress(buffer[, options], callback)`",
          "name": "zstdDecompress",
          "type": "method",
          "meta": {
            "added": [
              "v23.8.0",
              "v22.15.0"
            ],
            "changes": []
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                  "name": "buffer",
                  "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                },
                {
                  "textRaw": "`options` {zstd options}",
                  "name": "options",
                  "type": "zstd options",
                  "optional": true
                },
                {
                  "textRaw": "`callback` {Function}",
                  "name": "callback",
                  "type": "Function"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "`zlib.zstdDecompressSync(buffer[, options])`",
          "name": "zstdDecompressSync",
          "type": "method",
          "meta": {
            "added": [
              "v23.8.0",
              "v22.15.0"
            ],
            "changes": []
          },
          "stability": 1,
          "stabilityText": "Experimental",
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}",
                  "name": "buffer",
                  "type": "Buffer|TypedArray|DataView|ArrayBuffer|string"
                },
                {
                  "textRaw": "`options` {zstd options}",
                  "name": "options",
                  "type": "zstd options",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "<p>Decompress a chunk of data with <a href=\"#class-zlibzstddecompress\"><code>ZstdDecompress</code></a>.</p>"
        }
      ],
      "displayName": "Zlib"
    }
  ]
}