fflate/docs/classes/asyncgzip.md

Class: AsyncGzip

Asynchronous streaming DEFLATE compression Asynchronous streaming DEFLATE compression

Hierarchy

• AsyncCmpStrm<GzipOptions>

• AsyncCmpStrm<GzipOptions>

↳ AsyncGzip

Index

Constructors

• constructor

Properties

• ondata

Methods

• push

Constructors

constructor

+ new AsyncGzip(opts: GzipOptions, cb?: AsyncFlateStreamHandler): AsyncGzip

Inherited from AsyncDeflate.constructor

Overrides AsyncInflate.constructor

Creates an asynchronous compression stream

Parameters:

Name	Type	Description
opts	GzipOptions	The compression options
cb?	AsyncFlateStreamHandler	The callback to call whenever data is deflated

Returns: AsyncGzip

+ new AsyncGzip(cb?: AsyncFlateStreamHandler): AsyncGzip

Inherited from AsyncDeflate.constructor

Overrides AsyncInflate.constructor

Creates an asynchronous compression stream

Parameters:

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

Returns: AsyncGzip

Properties

ondata

• ondata: AsyncFlateStreamHandler

Inherited from AsyncDeflate.ondata

Overrides AsyncDeflate.ondata

The handler to call whenever data is available

Methods

push

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

Inherited from AsyncDeflate.push

Overrides AsyncInflate.push

Pushes a chunk to be deflated

Parameters:

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

Returns: void