summaryrefslogtreecommitdiff
path: root/docs/classes/unzipinflate.md
diff options
context:
space:
mode:
authorFlorian Dold <florian@dold.me>2021-08-20 13:31:03 +0200
committerFlorian Dold <florian@dold.me>2021-08-20 13:31:03 +0200
commit859a8734c87d5e5081d7b0aa02cb538a7c801eac (patch)
treed2e9163479eb56ec382c842d62ce39fe30d450a4 /docs/classes/unzipinflate.md
downloadnode-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/classes/unzipinflate.md')
-rw-r--r--docs/classes/unzipinflate.md68
1 files changed, 68 insertions, 0 deletions
diff --git a/docs/classes/unzipinflate.md b/docs/classes/unzipinflate.md
new file mode 100644
index 0000000..0da5623
--- /dev/null
+++ b/docs/classes/unzipinflate.md
@@ -0,0 +1,68 @@
+# Class: UnzipInflate
+
+Streaming DEFLATE decompression for ZIP archives. Prefer AsyncZipInflate for
+better performance.
+
+## Hierarchy
+
+* **UnzipInflate**
+
+## Implements
+
+* [UnzipDecoder](../interfaces/unzipdecoder.md)
+
+## Index
+
+### Constructors
+
+* [constructor](unzipinflate.md#constructor)
+
+### Properties
+
+* [ondata](unzipinflate.md#ondata)
+* [compression](unzipinflate.md#compression)
+
+### Methods
+
+* [push](unzipinflate.md#push)
+
+## Constructors
+
+### constructor
+
+\+ **new UnzipInflate**(): [UnzipInflate](unzipinflate.md)
+
+Creates a DEFLATE decompression that can be used in ZIP archives
+
+**Returns:** [UnzipInflate](unzipinflate.md)
+
+## Properties
+
+### ondata
+
+• **ondata**: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler)
+
+*Implementation of [UnzipDecoder](../interfaces/unzipdecoder.md).[ondata](../interfaces/unzipdecoder.md#ondata)*
+
+___
+
+### compression
+
+▪ `Static` **compression**: number = 8
+
+## Methods
+
+### push
+
+▸ **push**(`data`: Uint8Array, `final`: boolean): void
+
+*Implementation of [UnzipDecoder](../interfaces/unzipdecoder.md)*
+
+#### Parameters:
+
+Name | Type |
+------ | ------ |
+`data` | Uint8Array |
+`final` | boolean |
+
+**Returns:** void