Module

Node.Zlib.Types

For a better understanding of the types below, see these links:

data ZlibStream :: Compression -> Typedata ZlibStream t0

Transformer stream with a type-level value indicating which kind of compression is being used, either a Zlib type or a Brotli type. For example:

Zlibstream (Brotli BrotliCompress)
Zlibstream (Zlib Deflate)

Zlibstream extends Duplex and EventEmitter.

data Compression

Indicates whether a Zlib algorithm (i.e. "deflate" or "inflate") or Brotli algorithm is being used for compression/decompression.

data Zlib :: ZlibType -> Compressiondata Zlib t0

data Brotli :: BrotliType -> Compressiondata Brotli t0

data ZlibType

Indicates which Zlib type is being used.

data DeflateRaw :: ZlibTypedata DeflateRaw

Uses "deflate" algorithm to compress data with the following metadata:

In other words, the raw deflate bit stream with no metadata.

data Deflate :: ZlibTypedata Deflate

Uses "deflate" algorithm to compress data with the following metadata:

In other words, the raw deflate bit stream wrapped with some metadata.

data Gzip :: ZlibTypedata Gzip

Uses "deflate" algorithm to compress data with the following metadata:

In other words, the raw deflate bit stream wrapped with some metadata.

data InflateRaw :: ZlibTypedata InflateRaw

Uses "inflate" algorithm to decompress data that was compressed via DeflateRaw stream.

data Inflate :: ZlibTypedata Inflate

Uses "inflate" algorithm to decompress data that was compressed via Deflate stream.

data Gunzip :: ZlibTypedata Gunzip

Uses "inflate" algorithm to decompress data that was compressed via Gzip stream.

data Unzip :: ZlibTypedata Unzip

Decompresses data from either a Gunzip or Inflate stream by auto-detecting the header.

data BrotliType

Indicates whether the Brotli stream is compressing/decompressing the data

data BrotliCompress :: BrotliTypedata BrotliCompress

data BrotliDecompress :: BrotliTypedata BrotliDecompress

class UsesDeflate :: ZlibType -> Constraintclass UsesDeflate a

Indicates whether the ZlibType uses the "deflate" algorithm.