summaryrefslogtreecommitdiff
path: root/docs/classes/deflate.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/deflate.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/deflate.md')
-rw-r--r--docs/classes/deflate.md75
1 files changed, 75 insertions, 0 deletions
diff --git a/docs/classes/deflate.md b/docs/classes/deflate.md
new file mode 100644
index 0000000..3b9195a
--- /dev/null
+++ b/docs/classes/deflate.md
@@ -0,0 +1,75 @@
+# Class: Deflate
+
+Streaming DEFLATE compression
+
+## Hierarchy
+
+* **Deflate**
+
+## Index
+
+### Constructors
+
+* [constructor](deflate.md#constructor)
+
+### Properties
+
+* [ondata](deflate.md#ondata)
+
+### Methods
+
+* [push](deflate.md#push)
+
+## Constructors
+
+### constructor
+
+\+ **new Deflate**(`opts`: [DeflateOptions](../interfaces/deflateoptions.md), `cb?`: [FlateStreamHandler](../README.md#flatestreamhandler)): [Deflate](deflate.md)
+
+Creates a DEFLATE stream
+
+#### Parameters:
+
+Name | Type | Description |
+------ | ------ | ------ |
+`opts` | [DeflateOptions](../interfaces/deflateoptions.md) | The compression options |
+`cb?` | [FlateStreamHandler](../README.md#flatestreamhandler) | The callback to call whenever data is deflated |
+
+**Returns:** [Deflate](deflate.md)
+
+\+ **new Deflate**(`cb?`: [FlateStreamHandler](../README.md#flatestreamhandler)): [Deflate](deflate.md)
+
+Creates a DEFLATE stream
+
+#### Parameters:
+
+Name | Type | Description |
+------ | ------ | ------ |
+`cb?` | [FlateStreamHandler](../README.md#flatestreamhandler) | The callback to call whenever data is deflated |
+
+**Returns:** [Deflate](deflate.md)
+
+## Properties
+
+### ondata
+
+• **ondata**: [FlateStreamHandler](../README.md#flatestreamhandler)
+
+The handler to call whenever data is available
+
+## Methods
+
+### push
+
+▸ **push**(`chunk`: Uint8Array, `final?`: boolean): void
+
+Pushes a chunk to be deflated
+
+#### Parameters:
+
+Name | Type | Description |
+------ | ------ | ------ |
+`chunk` | Uint8Array | The chunk to push |
+`final?` | boolean | Whether this is the last chunk |
+
+**Returns:** void