summaryrefslogtreecommitdiff
path: root/docs/interfaces/deflateoptions.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/interfaces/deflateoptions.md')
-rw-r--r--docs/interfaces/deflateoptions.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/docs/interfaces/deflateoptions.md b/docs/interfaces/deflateoptions.md
new file mode 100644
index 0000000..74fe5d8
--- /dev/null
+++ b/docs/interfaces/deflateoptions.md
@@ -0,0 +1,56 @@
+# Interface: DeflateOptions
+
+Options for compressing data into a DEFLATE format
+
+## Hierarchy
+
+* **DeflateOptions**
+
+ ↳ [GzipOptions](gzipoptions.md)
+
+ ↳ [ZlibOptions](zliboptions.md)
+
+ ↳ [AsyncDeflateOptions](asyncdeflateoptions.md)
+
+ ↳ [ZipOptions](zipoptions.md)
+
+## Index
+
+### Properties
+
+* [level](deflateoptions.md#level)
+* [mem](deflateoptions.md#mem)
+
+## Properties
+
+### level
+
+• `Optional` **level**: 0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9
+
+The level of compression to use, ranging from 0-9.
+
+0 will store the data without compression.
+1 is fastest but compresses the worst, 9 is slowest but compresses the best.
+The default level is 6.
+
+Typically, binary data benefits much more from higher values than text data.
+In both cases, higher values usually take disproportionately longer than the reduction in final size that results.
+
+For example, a 1 MB text file could:
+- become 1.01 MB with level 0 in 1ms
+- become 400 kB with level 1 in 10ms
+- become 320 kB with level 9 in 100ms
+
+___
+
+### mem
+
+• `Optional` **mem**: 0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10 \| 11 \| 12
+
+The memory level to use, ranging from 0-12. Increasing this increases speed and compression ratio at the cost of memory.
+
+Note that this is exponential: while level 0 uses 4 kB, level 4 uses 64 kB, level 8 uses 1 MB, and level 12 uses 16 MB.
+It is recommended not to lower the value below 4, since that tends to hurt performance.
+In addition, values above 8 tend to help very little on most data and can even hurt performance.
+
+The default value is automatically determined based on the size of the input data.