Skip to content

Latest commit

 

History

History
58 lines (32 loc) · 1.35 KB

AsyncInflateOptions.md

File metadata and controls

58 lines (32 loc) · 1.35 KB

Interface: AsyncInflateOptions

Options for decompressing DEFLATE data asynchronously

Hierarchy

Table of contents

Properties

Properties

consume

Optional consume: boolean

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.

Inherited from

AsyncOptions.consume


dictionary

Optional dictionary: Uint8Array

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.

Inherited from

InflateStreamOptions.dictionary


size

Optional size: number

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.