Class AsyncDecompress

Asynchronous streaming GZIP, Zlib, or raw DEFLATE decompression

Index

Constructors

Methods

Properties

ondata ondrain? queuedSize

Constructors

constructor

new AsyncDecompress(
opts: InflateStreamOptions,
cb?: AsyncFlateStreamHandler,
): AsyncDecompress
Creates an asynchronous decompression stream
Parameters
- opts: InflateStreamOptions
  The decompression options
- Optionalcb: AsyncFlateStreamHandler
  The callback to call whenever data is decompressed
Returns AsyncDecompress
new AsyncDecompress(cb?: AsyncFlateStreamHandler): AsyncDecompress
Creates an asynchronous decompression stream
Parameters
- Optionalcb: AsyncFlateStreamHandler
  The callback to call whenever data is decompressed
Returns AsyncDecompress

Methods

push

push(chunk: Uint8Array, final?: boolean): void
Pushes a chunk to be decompressed
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