summaryrefslogtreecommitdiff
path: root/docs/interfaces/asyncinflateoptions.md
blob: 0586a5a415bab603157a38e865bfcc4fb7bfef19 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# Interface: AsyncInflateOptions

Options for decompressing DEFLATE data asynchronously

## Hierarchy

* AsyncOptions

  ↳ **AsyncInflateOptions**

  ↳↳ [AsyncUnzlibOptions](asyncunzliboptions.md)

## Index

### Properties

* [consume](asyncinflateoptions.md#consume)
* [size](asyncinflateoptions.md#size)

## Properties

### consume

• `Optional` **consume**: boolean

*Inherited from [AsyncDeflateOptions](asyncdeflateoptions.md).[consume](asyncdeflateoptions.md#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.

___

### 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.