diff options
Diffstat (limited to 'fflate/docs/interfaces/asyncinflateoptions.md')
-rw-r--r-- | fflate/docs/interfaces/asyncinflateoptions.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/fflate/docs/interfaces/asyncinflateoptions.md b/fflate/docs/interfaces/asyncinflateoptions.md new file mode 100644 index 0000000..0586a5a --- /dev/null +++ b/fflate/docs/interfaces/asyncinflateoptions.md @@ -0,0 +1,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. |