unzlib.md 1.6 KB

Class: Unzlib

Streaming Zlib decompression

Hierarchy

  • Unzlib

Index

Constructors

Properties

Methods

Constructors

constructor

+ new Unzlib(opts: UnzlibStreamOptions, cb?: FlateStreamHandler): Unzlib

Creates a Zlib decompression stream

Parameters:

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

Returns: Unzlib

+ new Unzlib(cb?: FlateStreamHandler): Unzlib

Creates a Zlib decompression stream

Parameters:

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

Returns: Unzlib

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 unzlibbed

Parameters:

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

Returns: void