Class: AsyncGunzip
May 16, 2026 ยท View on GitHub
Class: AsyncGunzip
Asynchronous streaming single or multi-member GZIP decompression
Constructors
Constructor
new AsyncGunzip(
opts:GunzipStreamOptions,cb?:AsyncFlateStreamHandler):AsyncGunzip
Creates an asynchronous GUNZIP stream
Parameters
opts
The decompression options
cb?
The callback to call whenever data is inflated
Returns
AsyncGunzip
Constructor
new AsyncGunzip(
cb?:AsyncFlateStreamHandler):AsyncGunzip
Creates an asynchronous GUNZIP stream
Parameters
cb?
The callback to call whenever data is inflated
Returns
AsyncGunzip
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)
onmember?
optionalonmember?:GunzipMemberHandler
The handler to call whenever a new GZIP member is found
queuedSize
queuedSize:
number
The number of compressed 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
push()
push(
chunk:Uint8Array,final?:boolean):void
Pushes a chunk to be GUNZIPped
Parameters
chunk
Uint8Array
The chunk to push
final?
boolean
Whether this is the last chunk
Returns
void