diff options
Diffstat (limited to 'docs/classes/decompress.md')
-rw-r--r-- | docs/classes/decompress.md | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/docs/classes/decompress.md b/docs/classes/decompress.md new file mode 100644 index 0000000..0e45e5b --- /dev/null +++ b/docs/classes/decompress.md @@ -0,0 +1,62 @@ +# Class: Decompress + +Streaming GZIP, Zlib, or raw DEFLATE decompression + +## Hierarchy + +* **Decompress** + +## Index + +### Constructors + +* [constructor](decompress.md#constructor) + +### Properties + +* [ondata](decompress.md#ondata) + +### Methods + +* [push](decompress.md#push) + +## Constructors + +### constructor + +\+ **new Decompress**(`cb?`: [FlateStreamHandler](../README.md#flatestreamhandler)): [Decompress](decompress.md) + +Creates a decompression stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`cb?` | [FlateStreamHandler](../README.md#flatestreamhandler) | The callback to call whenever data is decompressed | + +**Returns:** [Decompress](decompress.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 decompressed + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`chunk` | Uint8Array | The chunk to push | +`final?` | boolean | Whether this is the last chunk | + +**Returns:** void |