fflate/docs/classes/asyncdecompress.md

Class: AsyncDecompress

Asynchronous streaming GZIP, Zlib, or raw DEFLATE decompression

Hierarchy

• AsyncDecompress

Index

Constructors

• constructor

Properties

• ondata

Methods

• push

Constructors

constructor

+ new AsyncDecompress(opts: InflateStreamOptions, cb?: AsyncFlateStreamHandler): AsyncDecompress

Creates an asynchronous decompression stream

Parameters:

Name	Type	Description
opts	InflateStreamOptions	The decompression options
cb?	AsyncFlateStreamHandler	The callback to call whenever data is decompressed

Returns: AsyncDecompress

+ new AsyncDecompress(cb?: AsyncFlateStreamHandler): AsyncDecompress

Creates an asynchronous decompression stream

Parameters:

Name	Type	Description
cb?	AsyncFlateStreamHandler	The callback to call whenever data is decompressed

Returns: AsyncDecompress

Properties

ondata

• ondata: AsyncFlateStreamHandler

The handler to call whenever data is available

Methods

push

▸ push(chunk: Uint8Array, final?: boolean): void

Pushes a chunk to be decompressed

Parameters:

Name	Type	Description
chunk	Uint8Array	The chunk to push
final?	boolean	Whether this is the last chunk

Returns: void