decompress.md 1.7 KB

Class: Decompress

Streaming GZIP, Zlib, or raw DEFLATE decompression

Hierarchy

  • Decompress

Index

Constructors

Properties

Methods

Constructors

constructor

+ new Decompress(opts: InflateStreamOptions, cb?: AsyncFlateStreamHandler): Decompress

Creates a decompression stream

Parameters:

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

Returns: Decompress

+ new Decompress(cb?: AsyncFlateStreamHandler): Decompress

Creates a decompression stream

Parameters:

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

Returns: Decompress

Properties

ondata

ondata: FlateStreamHandler

The handler to call whenever data is available

Methods

push

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

Pushes a chunk to be decompressed

Parameters:

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

Returns: void