diff options
author | Florian Dold <florian@dold.me> | 2021-08-20 13:31:03 +0200 |
---|---|---|
committer | Florian Dold <florian@dold.me> | 2021-08-20 13:31:03 +0200 |
commit | 859a8734c87d5e5081d7b0aa02cb538a7c801eac (patch) | |
tree | d2e9163479eb56ec382c842d62ce39fe30d450a4 /docs/interfaces/asyncunzliboptions.md | |
download | node-vendor-859a8734c87d5e5081d7b0aa02cb538a7c801eac.tar.gz node-vendor-859a8734c87d5e5081d7b0aa02cb538a7c801eac.tar.bz2 node-vendor-859a8734c87d5e5081d7b0aa02cb538a7c801eac.zip |
Squashed 'fflate/' content from commit b786929
git-subtree-dir: fflate
git-subtree-split: b786929a368521e9cfcdcf7490a8e77485d5a253
Diffstat (limited to 'docs/interfaces/asyncunzliboptions.md')
-rw-r--r-- | docs/interfaces/asyncunzliboptions.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/interfaces/asyncunzliboptions.md b/docs/interfaces/asyncunzliboptions.md new file mode 100644 index 0000000..053fedd --- /dev/null +++ b/docs/interfaces/asyncunzliboptions.md @@ -0,0 +1,39 @@ +# Interface: AsyncUnzlibOptions + +Options for decompressing Zlib data asynchronously + +## Hierarchy + +* [AsyncInflateOptions](asyncinflateoptions.md) + + ↳ **AsyncUnzlibOptions** + +## Index + +### Properties + +* [consume](asyncunzliboptions.md#consume) +* [size](asyncunzliboptions.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 + +*Inherited from [AsyncInflateOptions](asyncinflateoptions.md).[size](asyncinflateoptions.md#size)* + +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. |