fflate/docs/classes/gunzip.md

Class: Gunzip

Streaming single or multi-member GZIP decompression

Hierarchy

• Gunzip

Index

Constructors

• constructor

Properties

• ondata
• onmember

Methods

• push

Constructors

constructor

+ new Gunzip(opts: GunzipStreamOptions, cb?: FlateStreamHandler): Gunzip

Creates a GUNZIP stream

Parameters:

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

Returns: Gunzip

+ new Gunzip(cb?: FlateStreamHandler): Gunzip

Creates a GUNZIP stream

Parameters:

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

Returns: Gunzip

Properties

ondata

• ondata: FlateStreamHandler

The handler to call whenever data is available

---

onmember

• Optional onmember: GunzipMemberHandler

The handler to call whenever a new GZIP member is found

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