Node.js v26.9.0 documentation
- Node.js v26.9.0
- Table of contents
- Zlib
- Threadpool usage and performance considerations
- Compressing HTTP requests and responses
- Memory usage tuning
- Flushing
- Constants
- Class:
Options - Class:
BrotliOptions - Class:
zlib.BrotliCompress - Class:
zlib.BrotliDecompress - Class:
zlib.Deflate - Class:
zlib.DeflateRaw - Class:
zlib.Gunzip - Class:
zlib.Gzip - Class:
zlib.Inflate - Class:
zlib.InflateRaw - Class:
zlib.Unzip - Class:
zlib.ZipBuffernew zlib.ZipBuffer(buffer)zipBuffer.add(filename, data[, options])zipBuffer.addSync(filename, data[, options])zipBuffer.addEntry(entry)zipBuffer.clear()zipBuffer.commentzipBuffer.delete(name)zipBuffer.entries()zipBuffer.forEach(callback[, thisArg])zipBuffer.get(name)zipBuffer.has(name)zipBuffer.keys()zipBuffer.sizezipBuffer.toBuffer([options])zipBuffer.toBufferSync([options])zipBuffer.values()zipBuffer.writable
- Class:
zlib.ZipEntry- Static method:
zlib.ZipEntry.create(filename, data[, options]) - Static method:
zlib.ZipEntry.createStream(filename, source[, options]) - Static method:
zlib.ZipEntry.createSymlink(filename, target[, options]) - Static method:
zlib.ZipEntry.createSync(filename, data[, options]) - Static method:
zlib.ZipEntry.read(buffer) zipEntry.commentzipEntry.compressedzipEntry.compressedSizezipEntry.content([options])zipEntry.contentSync([options])zipEntry.contentIterator([options])zipEntry.crc32zipEntry.flagszipEntry.isDirectoryzipEntry.isFilezipEntry.isSymlinkzipEntry.modezipEntry.modifiedzipEntry.methodzipEntry.namezipEntry.nameBufferzipEntry.rawContentzipEntry.size
- Static method:
- Class:
zlib.ZipFile- Static method:
zlib.ZipFile.open(filename[, options]) - Static method:
zlib.ZipFile.openSync(filename[, options]) zipFile.add(filename, data[, options])zipFile.addEntry(entry)zipFile.addEntrySync(entry)zipFile.addSync(filename, data[, options])zipFile.close()zipFile.closeSync()zipFile.commentzipFile.compact([comment])zipFile.compactSync([comment])zipFile.delete(name)zipFile.deleteSync(name)zipFile.entries()zipFile.entriesSync()zipFile.forEach(callback[, thisArg])zipFile.forEachSync(callback[, thisArg])zipFile.get(name)zipFile.getSync(name)zipFile.has(name)zipFile.keys()zipFile.sizezipFile.stream(name[, options])zipFile.values()zipFile.valuesSync()zipFile.writable
- Static method:
- Class:
zlib.ZlibBase - Class:
ZstdOptions - Class:
zlib.ZstdCompress - Class:
zlib.ZstdDecompress zlib.constantszlib.crc32(data[, value])zlib.createBrotliCompress([options])zlib.createBrotliDecompress([options])zlib.createDeflate([options])zlib.createDeflateRaw([options])zlib.createGunzip([options])zlib.createGzip([options])zlib.createInflate([options])zlib.createInflateRaw([options])zlib.createUnzip([options])zlib.createZipArchive(entries[, options])zlib.createZipArchiveSync(entries[, options])zlib.zipFiles(files[, options])zlib.createZstdCompress([options])zlib.createZstdDecompress([options])zlib.getMaxZipContentSize()zlib.setMaxZipContentSize(size)- Convenience methods
zlib.brotliCompress(buffer[, options], callback)zlib.brotliCompressSync(buffer[, options])zlib.brotliDecompress(buffer[, options], callback)zlib.brotliDecompressSync(buffer[, options])zlib.deflate(buffer[, options], callback)zlib.deflateSync(buffer[, options])zlib.deflateRaw(buffer[, options], callback)zlib.deflateRawSync(buffer[, options])zlib.gunzip(buffer[, options], callback)zlib.gunzipSync(buffer[, options])zlib.gzip(buffer[, options], callback)zlib.gzipSync(buffer[, options])zlib.inflate(buffer[, options], callback)zlib.inflateSync(buffer[, options])zlib.inflateRaw(buffer[, options], callback)zlib.inflateRawSync(buffer[, options])zlib.unzip(buffer[, options], callback)zlib.unzipSync(buffer[, options])zlib.zstdCompress(buffer[, options], callback)zlib.zstdCompressSync(buffer[, options])zlib.zstdDecompress(buffer[, options], callback)zlib.zstdDecompressSync(buffer[, options])
- Iterable Compression
compressBrotli([options])compressBrotliSync([options])compressDeflate([options])compressDeflateSync([options])compressGzip([options])compressGzipSync([options])compressZstd([options])compressZstdSync([options])decompressBrotli([options])decompressBrotliSync([options])decompressDeflate([options])decompressDeflateSync([options])decompressGzip([options])decompressGzipSync([options])decompressZstd([options])decompressZstdSync([options])
- Zlib
- Index