Class AsyncGunzip
Index
Constructors
constructor
- new
Async (opts, cb?): AsyncGunzipGunzip Creates an asynchronous GUNZIP stream
Parameters
- opts: GunzipStreamOptions
The decompression options
Optionalcb: AsyncFlateStreamHandlerThe callback to call whenever data is inflated
Returns AsyncGunzip
- opts: GunzipStreamOptions
- new
Async (cb?): AsyncGunzipGunzip Creates an asynchronous GUNZIP stream
Parameters
Optionalcb: AsyncFlateStreamHandlerThe callback to call whenever data is inflated
Returns AsyncGunzip
Methods
push
- push(chunk, final?): void
Pushes a chunk to be GUNZIPped
Parameters
- chunk: Uint8Array
The chunk to push
Optionalfinal: booleanWhether this is the last chunk
Returns void
- chunk: Uint8Array
Properties
ondata
The handler to call whenever data is available
Optionalondrain
The handler to call whenever buffered source data is processed (i.e. queuedSize updates)
Optionalonmember
The handler to call whenever a new GZIP member is found
queuedSize
queuedSize : number
The number of compressed bytes buffered in the stream
terminate
A method to terminate the stream's internal worker. Subsequent calls to push() will silently fail.
Asynchronous streaming single or multi-member GZIP decompression