summaryrefslogtreecommitdiff
path: root/fflate/docs/interfaces/unzipdecoderconstructor.md
diff options
context:
space:
mode:
Diffstat (limited to 'fflate/docs/interfaces/unzipdecoderconstructor.md')
-rw-r--r--fflate/docs/interfaces/unzipdecoderconstructor.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/fflate/docs/interfaces/unzipdecoderconstructor.md b/fflate/docs/interfaces/unzipdecoderconstructor.md
new file mode 100644
index 0000000..88388c7
--- /dev/null
+++ b/fflate/docs/interfaces/unzipdecoderconstructor.md
@@ -0,0 +1,45 @@
+# Interface: UnzipDecoderConstructor
+
+A constructor for a decoder for unzip streams
+
+## Hierarchy
+
+* **UnzipDecoderConstructor**
+
+## Index
+
+### Constructors
+
+* [constructor](unzipdecoderconstructor.md#constructor)
+
+### Properties
+
+* [compression](unzipdecoderconstructor.md#compression)
+
+## Constructors
+
+### constructor
+
+\+ **new UnzipDecoderConstructor**(`filename`: string, `size?`: number, `originalSize?`: number): [UnzipDecoder](unzipdecoder.md)
+
+Creates an instance of the decoder
+
+#### Parameters:
+
+Name | Type | Description |
+------ | ------ | ------ |
+`filename` | string | The name of the file |
+`size?` | number | The compressed size of the file |
+`originalSize?` | number | The original size of the file |
+
+**Returns:** [UnzipDecoder](unzipdecoder.md)
+
+## Properties
+
+### compression
+
+• **compression**: number
+
+The compression format for the data stream. This number is determined by
+the spec in PKZIP's APPNOTE.txt, section 4.4.5. For example, 0 = no
+compression, 8 = deflate, 14 = LZMA