Interface AsyncInflateOptions

Options for decompressing DEFLATE data asynchronously

interface AsyncInflateOptions {
    consume?: boolean;
    dictionary?: Uint8Array;
    size?: number;
}
Hierarchy

Properties

consume? dictionary? size?

Properties

Optionalconsume

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.

Optionaldictionary

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.

Optionalsize

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.

Settings

Member Visibility

On This Page

Properties