Class AsyncUnzlib

Asynchronous streaming Zlib decompression

Index

Constructors

Methods

Properties

ondata ondrain? queuedSize terminate

Constructors

constructor

new AsyncUnzlib(
opts: UnzlibStreamOptions,
cb?: AsyncFlateStreamHandler,
): AsyncUnzlib
Creates an asynchronous Zlib decompression stream
Parameters
- opts: UnzlibStreamOptions
  The decompression options
- Optionalcb: AsyncFlateStreamHandler
  The callback to call whenever data is inflated
Returns AsyncUnzlib
new AsyncUnzlib(cb?: AsyncFlateStreamHandler): AsyncUnzlib
Creates an asynchronous Zlib decompression stream
Parameters
- Optionalcb: AsyncFlateStreamHandler
  The callback to call whenever data is inflated
Returns AsyncUnzlib

Methods

push

push(chunk: Uint8Array, final?: boolean): void
Pushes a chunk to be decompressed from Zlib
Parameters
- chunk: Uint8Array
  The chunk to push
- Optionalfinal: boolean
  Whether this is the last chunk
Returns void

Properties

ondata

ondata: AsyncFlateStreamHandler

The handler to call whenever data is available

`Optional`ondrain

ondrain?: AsyncFlateDrainHandler

The handler to call whenever buffered source data is processed (i.e. queuedSize updates)

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.