fflate/docs/classes/asyncunzlib.md

Class: AsyncUnzlib

Asynchronous streaming Zlib decompression

Hierarchy

• AsyncUnzlib

Index

Constructors

• constructor

Properties

• ondata
• terminate

Methods

• push

Constructors

constructor

+ new AsyncUnzlib(opts: UnzlibStreamOptions, cb?: AsyncFlateStreamHandler): AsyncUnzlib

Creates an asynchronous Zlib decompression stream

Parameters:

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

Returns: AsyncUnzlib

+ new AsyncUnzlib(cb?: AsyncFlateStreamHandler): AsyncUnzlib

Creates an asynchronous Zlib decompression stream

Parameters:

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

Returns: AsyncUnzlib

Properties

ondata

• ondata: AsyncFlateStreamHandler

The handler to call whenever data is available

---

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 decompressed from Zlib

Parameters:

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

Returns: void