Class: AsyncGzip
May 16, 2026 ยท View on GitHub
Class: AsyncGzip
Asynchronous streaming GZIP compression
Constructors
Constructor
new AsyncGzip(
opts:GzipOptions,cb?:AsyncFlateStreamHandler):AsyncGzip
Creates an asynchronous GZIP stream
Parameters
opts
The compression options
cb?
The callback to call whenever data is deflated
Returns
AsyncGzip
Constructor
new AsyncGzip(
cb?:AsyncFlateStreamHandler):AsyncGzip
Creates an asynchronous GZIP stream
Parameters
cb?
The callback to call whenever data is deflated
Returns
AsyncGzip
Properties
ondata
ondata:
AsyncFlateStreamHandler
The handler to call whenever data is available
ondrain?
optionalondrain?:AsyncFlateDrainHandler
The handler to call whenever buffered source data is processed (i.e. queuedSize updates)
queuedSize
queuedSize:
number
The number of uncompressed bytes buffered in the stream
terminate
terminate:
AsyncTerminable
A method to terminate the stream's internal worker. Subsequent calls to push() will silently fail.
Methods
flush()
flush(
sync?:boolean):void
Flushes buffered uncompressed data. Useful to immediately retrieve the GZIPped output for small inputs.
Parameters
sync?
boolean
Whether to flush to a byte boundary. A sync flush takes 4-5 extra bytes, but guarantees all pushed data is immediately decompressible.
Returns
void
push()
push(
chunk:Uint8Array,final?:boolean):void
Pushes a chunk to be GZIPped
Parameters
chunk
Uint8Array
The chunk to push
final?
boolean
Whether this is the last chunk
Returns
void