fflate/docs/classes/asyncgunzip.md

Class: AsyncGunzip

Asynchronous streaming single or multi-member GZIP decompression

Hierarchy

• AsyncGunzip

Index

Constructors

• constructor

Properties

• ondata
• onmember
• terminate

Methods

• push

Constructors

constructor

+ new AsyncGunzip(opts: GunzipStreamOptions, cb?: AsyncFlateStreamHandler): AsyncGunzip

Creates an asynchronous GUNZIP stream

Parameters:

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

Returns: AsyncGunzip

+ new AsyncGunzip(cb?: AsyncFlateStreamHandler): AsyncGunzip

Creates an asynchronous GUNZIP stream

Parameters:

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

Returns: AsyncGunzip

Properties

ondata

• ondata: AsyncFlateStreamHandler

The handler to call whenever data is available

---

onmember

• Optional onmember: GunzipMemberHandler

The handler to call whenever a new GZIP member is found

---

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 GUNZIPped

Parameters:

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

Returns: void