asyncunzliboptions.md 1.4 KB

Interface: AsyncUnzlibOptions

Options for decompressing Zlib data asynchronously

Hierarchy

AsyncUnzlibOptions

Index

Properties

Properties

consume

Optional consume: boolean

Inherited from AsyncDeflateOptions.consume

Whether or not to "consume" the source data. This will make the typed array/buffer you pass in unusable but will increase performance and reduce memory usage.


dictionary

Optional dictionary: Uint8Array

Inherited from InflateStreamOptions.dictionary

The dictionary used to compress the original data. If no dictionary was used during compression, this option has no effect.

Supplying the wrong dictionary during decompression usually yields corrupt output or causes an invalid distance error.


size

Optional size: number

Inherited from AsyncInflateOptions.size

The original size of the data. Currently, the asynchronous API disallows writing into a buffer you provide; the best you can do is provide the size in bytes and be given back a new typed array.