fflate/docs/interfaces/asyncgunzipoptions.md

Interface: AsyncGunzipOptions

Options for decompressing GZIP data asynchronously

Hierarchy

• AsyncOptions

• InflateStreamOptions

↳ AsyncGunzipOptions

Index

Properties

• consume
• dictionary

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.