Class AsyncCompress

Asynchronous streaming GZIP compression

Index

Constructors

Methods

Properties

ondata ondrain? queuedSize terminate

Constructors

constructor

new AsyncCompress(
opts: GzipOptions,
cb?: AsyncFlateStreamHandler,
): AsyncCompress
Creates an asynchronous GZIP stream
Parameters
- opts: GzipOptions
  The compression options
- Optionalcb: AsyncFlateStreamHandler
  The callback to call whenever data is deflated
Returns AsyncCompress
new AsyncCompress(cb?: AsyncFlateStreamHandler): AsyncCompress
Creates an asynchronous GZIP stream
Parameters
- Optionalcb: AsyncFlateStreamHandler
  The callback to call whenever data is deflated
Returns AsyncCompress

Methods

flush

flush(sync?: boolean): void
Flushes buffered uncompressed data. Useful to immediately retrieve the GZIPped output for small inputs.
Parameters
- Optionalsync: boolean
  Whether to flush to a byte boundary. A sync flush takes 4-5 extra bytes, but guarantees all pushed data is immediately decompressible.
Returns void

push

push(chunk: Uint8Array, final?: boolean): void
Pushes a chunk to be GZIPped
Parameters
- chunk: Uint8Array
  The chunk to push
- Optionalfinal: boolean
  Whether this is the last chunk
Returns void

Properties

ondata

ondata: AsyncFlateStreamHandler

The handler to call whenever data is available

`Optional`ondrain

ondrain?: AsyncFlateDrainHandler

The handler to call whenever buffered source data is processed (i.e. queuedSize updates)

queuedSize

queuedSize: number

The number of uncompressed bytes buffered in the stream

terminate

terminate: AsyncTerminable

A method to terminate the stream's internal worker. Subsequent calls to push() will silently fail.