Module

Node.Zlib

Package: purescript-node-zlib
Repository: purescript-node/purescript-node-zlib

Module contains the following:

Functions that work on the Zlib streams, regardless of which compression is used
- toDuplex
- bytesWritten
create* and create*' functions that create a Transformer stream which compresses/decompresses Stream-based data. Intended to be used with Stream.pipeline.
<algorithm>* functions, which mutates a buffer by compressing/decompressing the data within. Comes in 3 variants:
- *Sync/*Sync' - synchronous version with/without options
- */*' - assynchronous version with/without options
- *Aff/*Aff' - Aff-based assynchronous version with/without options

#toDuplex Source

toDuplex :: forall compression. ZlibStream compression -> Duplex

#bytesWritten Source

bytesWritten :: forall compression. ZlibStream compression -> Effect Number

#createBrotliCompress Source

createBrotliCompress :: Effect (ZlibStream (Brotli BrotliCompress))

#createBrotliCompress' Source

createBrotliCompress' :: forall r trash. Union r trash (BrotliOptions BrotliCompress) => Record r -> Effect (ZlibStream (Brotli BrotliCompress))

#createBrotliDecompress Source

createBrotliDecompress :: Effect (ZlibStream (Brotli BrotliDecompress))

#createBrotliDecompress' Source

createBrotliDecompress' :: forall r trash. Union r trash (BrotliOptions BrotliDecompress) => Record r -> Effect (ZlibStream (Brotli BrotliDecompress))

#createDeflateRaw Source

createDeflateRaw :: Effect (ZlibStream (Zlib DeflateRaw))

#createDeflateRaw' Source

createDeflateRaw' :: forall r trash. Union r trash DeflateOptions => Record r -> Effect (ZlibStream (Zlib DeflateRaw))

#createDeflate Source

createDeflate :: Effect (ZlibStream (Zlib Deflate))

#createDeflate' Source

createDeflate' :: forall r trash. Union r trash DeflateOptions => Record r -> Effect (ZlibStream (Zlib Deflate))

#createGzip Source

createGzip :: Effect (ZlibStream (Zlib Gzip))

#createGzip' Source

createGzip' :: forall r trash. Union r trash GzipOptions => Record r -> Effect (ZlibStream (Zlib Gzip))

#createInflateRaw Source

createInflateRaw :: Effect (ZlibStream (Zlib InflateRaw))

#createInflateRaw' Source

createInflateRaw' :: forall r trash. Union r trash InflateOptions => Record r -> Effect (ZlibStream (Zlib InflateRaw))

#createInflate Source

createInflate :: Effect (ZlibStream (Zlib Inflate))

#createInflate' Source

createInflate' :: forall r trash. Union r trash InflateOptions => Record r -> Effect (ZlibStream (Zlib Inflate))

#createGunzip Source

createGunzip :: Effect (ZlibStream (Zlib Gunzip))

#createGunzip' Source

createGunzip' :: forall r trash. Union r trash GunzipOptions => Record r -> Effect (ZlibStream (Zlib Gunzip))

#createUnzip Source

createUnzip :: Effect (ZlibStream (Zlib Unzip))

#createUnzip' Source

createUnzip' :: forall r trash. Union r trash InflateOptions => Record r -> Effect (ZlibStream (Zlib Unzip))

#brotliCompressSync Source

brotliCompressSync :: Buffer -> Effect Unit

#brotliCompressSync' Source

brotliCompressSync' :: forall r trash. Union r trash (maxOutputLength :: Int | BrotliOptions BrotliCompress) => Buffer -> Record r -> Effect Unit

#brotliCompress Source

brotliCompress :: Buffer -> Effect Unit -> Effect Unit

#brotliCompress' Source

brotliCompress' :: forall r trash. Union r trash (maxOutputLength :: Int | BrotliOptions BrotliCompress) => Buffer -> Record r -> Effect Unit -> Effect Unit

#brotliCompressAff Source

brotliCompressAff :: Buffer -> Aff Unit

#brotliCompressAff' Source

brotliCompressAff' :: forall r trash. Union r trash (maxOutputLength :: Int | BrotliOptions BrotliCompress) => Buffer -> Record r -> Aff Unit

#brotliDecompressSync Source

brotliDecompressSync :: Buffer -> Effect Unit

#brotliDecompressSync' Source

brotliDecompressSync' :: forall r trash. Union r trash (maxOutputLength :: Int | BrotliOptions BrotliDecompress) => Buffer -> Record r -> Effect Unit

#brotliDecompress Source

brotliDecompress :: Buffer -> Effect Unit -> Effect Unit

#brotliDecompress' Source

brotliDecompress' :: forall r trash. Union r trash (maxOutputLength :: Int | BrotliOptions BrotliDecompress) => Buffer -> Record r -> Effect Unit -> Effect Unit

#brotliDecompressAff Source

brotliDecompressAff :: Buffer -> Aff Unit

#brotliDecompressAff' Source

brotliDecompressAff' :: forall r trash. Union r trash (maxOutputLength :: Int | BrotliOptions BrotliDecompress) => Buffer -> Record r -> Aff Unit

#deflateRawSync Source

deflateRawSync :: Buffer -> Effect Unit

#deflateRawSync' Source

deflateRawSync' :: forall r trash. Union r trash (maxOutputLength :: Int | DeflateOptions) => Buffer -> Record r -> Effect Unit

#deflateRaw Source

deflateRaw :: Buffer -> Effect Unit -> Effect Unit

#deflateRaw' Source

deflateRaw' :: forall r trash. Union r trash (maxOutputLength :: Int | DeflateOptions) => Buffer -> Record r -> Effect Unit -> Effect Unit

#deflateRawAff Source

deflateRawAff :: Buffer -> Aff Unit

#deflateRawAff' Source

deflateRawAff' :: forall r trash. Union r trash (maxOutputLength :: Int | DeflateOptions) => Buffer -> Record r -> Aff Unit

#deflateSync Source

deflateSync :: Buffer -> Effect Unit

#deflateSync' Source

deflateSync' :: forall r trash. Union r trash (maxOutputLength :: Int | DeflateOptions) => Buffer -> Record r -> Effect Unit

#deflate Source

deflate :: Buffer -> Effect Unit -> Effect Unit

#deflate' Source

deflate' :: forall r trash. Union r trash (maxOutputLength :: Int | DeflateOptions) => Buffer -> Record r -> Effect Unit -> Effect Unit

#deflateAff Source

deflateAff :: Buffer -> Aff Unit

#deflateAff' Source

deflateAff' :: forall r trash. Union r trash (maxOutputLength :: Int | DeflateOptions) => Buffer -> Record r -> Aff Unit

#gzipSync Source

gzipSync :: Buffer -> Effect Unit

#gzipSync' Source

gzipSync' :: forall r trash. Union r trash (maxOutputLength :: Int | GzipOptions) => Buffer -> Record r -> Effect Unit

#gzip Source

gzip :: Buffer -> Effect Unit -> Effect Unit

#gzip' Source

gzip' :: forall r trash. Union r trash (maxOutputLength :: Int | GzipOptions) => Buffer -> Record r -> Effect Unit -> Effect Unit

#gzipAff Source

gzipAff :: Buffer -> Aff Unit

#gzipAff' Source

gzipAff' :: forall r trash. Union r trash (maxOutputLength :: Int | GzipOptions) => Buffer -> Record r -> Aff Unit

#inflateRawSync Source

inflateRawSync :: Buffer -> Effect Unit

#inflateRawSync' Source

inflateRawSync' :: forall r trash. Union r trash (maxOutputLength :: Int | InflateOptions) => Buffer -> Record r -> Effect Unit

#inflateRaw Source

inflateRaw :: Buffer -> Effect Unit -> Effect Unit

#inflateRaw' Source

inflateRaw' :: forall r trash. Union r trash (maxOutputLength :: Int | InflateOptions) => Buffer -> Record r -> Effect Unit -> Effect Unit

#inflateRawAff Source

inflateRawAff :: Buffer -> Aff Unit

#inflateRawAff' Source

inflateRawAff' :: forall r trash. Union r trash (maxOutputLength :: Int | InflateOptions) => Buffer -> Record r -> Aff Unit

#inflateSync Source

inflateSync :: Buffer -> Effect Unit

#inflateSync' Source

inflateSync' :: forall r trash. Union r trash (maxOutputLength :: Int | InflateOptions) => Buffer -> Record r -> Effect Unit

#inflate Source

inflate :: Buffer -> Effect Unit -> Effect Unit

#inflate' Source

inflate' :: forall r trash. Union r trash (maxOutputLength :: Int | InflateOptions) => Buffer -> Record r -> Effect Unit -> Effect Unit

#inflateAff Source

inflateAff :: Buffer -> Aff Unit

#inflateAff' Source

inflateAff' :: forall r trash. Union r trash (maxOutputLength :: Int | InflateOptions) => Buffer -> Record r -> Aff Unit

#gunzipSync Source

gunzipSync :: Buffer -> Effect Unit

#gunzipSync' Source

gunzipSync' :: forall r trash. Union r trash (maxOutputLength :: Int | GunzipOptions) => Buffer -> Record r -> Effect Unit

#gunzip Source

gunzip :: Buffer -> Effect Unit -> Effect Unit

#gunzip' Source

gunzip' :: forall r trash. Union r trash (maxOutputLength :: Int | GunzipOptions) => Buffer -> Record r -> Effect Unit -> Effect Unit

#gunzipAff Source

gunzipAff :: Buffer -> Aff Unit

#gunzipAff' Source

gunzipAff' :: forall r trash. Union r trash (maxOutputLength :: Int | GunzipOptions) => Buffer -> Record r -> Aff Unit

#unzipSync Source

unzipSync :: Buffer -> Effect Unit

#unzipSync' Source

unzipSync' :: forall r trash. Union r trash (maxOutputLength :: Int | DeflateOptions) => Buffer -> Record r -> Effect Unit

#unzip Source

unzip :: Buffer -> Effect Unit -> Effect Unit

#unzip' Source

unzip' :: forall r trash. Union r trash (maxOutputLength :: Int | DeflateOptions) => Buffer -> Record r -> Effect Unit -> Effect Unit

#unzipAff Source

unzipAff :: Buffer -> Aff Unit

#unzipAff' Source

unzipAff' :: forall r trash. Union r trash (maxOutputLength :: Int | DeflateOptions) => Buffer -> Record r -> Aff Unit

Modules: Node.Zlib; Node.Zlib.Brotli; Node.Zlib.Types; Node.Zlib.Z