Skip to content
comprs
Search
Ctrl
K
Cancel
GitHub
npm
Select theme
Dark
Light
Auto
Menu
Start here
Getting started
Choosing an algorithm
Playground
Guides
Unified API
Streaming
Dictionaries
Browsers
Servers and frameworks
Migration
From pako
From fflate
From node:zlib
From brotli-wasm
From @mongodb-js/zstd
Reference
Classic API
Errors and limits
Memory
Platforms
Benchmarks
API reference
Overview
index
Overview
Enumerations
CompressionFormat
Classes
BrotliCompressContext
BrotliCompressDictContext
BrotliDecompressContext
BrotliDecompressDictContext
DeflateCompressContext
DeflateDecompressContext
GzipCompressContext
GzipDecompressContext
Lz4CompressContext
Lz4DecompressContext
ZstdCompressContext
ZstdCompressDictContext
ZstdDecompressContext
ZstdDecompressDictContext
Interfaces
GzipHeader
GzipHeaderOptions
StreamContextOptions
Variables
__napiBindingTarget
Functions
brotliCompress
brotliCompressAsync
brotliCompressWithDict
brotliCompressWithDictAsync
brotliDecompress
brotliDecompressAsync
brotliDecompressWithCapacity
brotliDecompressWithCapacityAsync
brotliDecompressWithDict
brotliDecompressWithDictAsync
brotliDecompressWithDictWithCapacity
brotliDecompressWithDictWithCapacityAsync
crc32
decompress
decompressAsync
deflateCompress
deflateCompressAsync
deflateDecompress
deflateDecompressAsync
deflateDecompressWithCapacity
deflateDecompressWithCapacityAsync
detectFormat
gzipCompress
gzipCompressAsync
gzipCompressWithHeader
gzipDecompress
gzipDecompressAsync
gzipDecompressWithCapacity
gzipDecompressWithCapacityAsync
gzipReadHeader
lz4Compress
lz4CompressAsync
lz4Decompress
lz4DecompressAsync
lz4DecompressWithCapacity
lz4DecompressWithCapacityAsync
version
zstdCompress
zstdCompressAsync
zstdCompressWithDict
zstdCompressWithDictAsync
zstdDecompress
zstdDecompressAsync
zstdDecompressWithCapacity
zstdDecompressWithCapacityAsync
zstdDecompressWithDict
zstdDecompressWithDictAsync
zstdDecompressWithDictWithCapacity
zstdDecompressWithDictWithCapacityAsync
zstdTrainDictionary
zstdTrainDictionaryAsync
next
Overview
Classes
CompressionStream
DecompressionStream
Dictionary
Interfaces
AbortOptions
AbortSignalLike
CompressOptions
DecompressOptions
DictionaryOptions
GzipHeaderOptions
TrainDictionaryOptions
Type Aliases
Bytes
CompressionStreamOptions
DecompressionStreamOptions
ErrorCode
Format
Input
Functions
compress
compressSync
decompress
decompressSync
detectFormat
trainDictionary
trainDictionarySync
node
Overview
Functions
createBrotliCompressDictTransform
createBrotliCompressTransform
createBrotliDecompressDictTransform
createBrotliDecompressTransform
createDecompressTransform
createDeflateCompressTransform
createDeflateDecompressTransform
createGzipCompressTransform
createGzipDecompressTransform
createLz4CompressTransform
createLz4DecompressTransform
createZstdCompressDictTransform
createZstdCompressTransform
createZstdDecompressDictTransform
createZstdDecompressTransform
streams
Overview
Functions
createBrotliCompressDictStream
createBrotliCompressStream
createBrotliDecompressDictStream
createBrotliDecompressStream
createDecompressStream
createDeflateCompressStream
createDeflateDecompressStream
createGzipCompressStream
createGzipDecompressStream
createLz4CompressStream
createLz4DecompressStream
createZstdCompressDictStream
createZstdCompressStream
createZstdDecompressDictStream
createZstdDecompressStream
GitHub
npm
Select theme
Dark
Light
Auto
version
version
():
string
Defined in:
index.d.ts:1645
Returns the library version.
Returns
Section titled “Returns”
string