diff options
author | Florian Dold <florian@dold.me> | 2021-08-20 13:31:03 +0200 |
---|---|---|
committer | Florian Dold <florian@dold.me> | 2021-08-20 13:31:03 +0200 |
commit | 859a8734c87d5e5081d7b0aa02cb538a7c801eac (patch) | |
tree | d2e9163479eb56ec382c842d62ce39fe30d450a4 /docs/classes/asynczipdeflate.md | |
download | node-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/asynczipdeflate.md')
-rw-r--r-- | docs/classes/asynczipdeflate.md | 182 |
1 files changed, 182 insertions, 0 deletions
diff --git a/docs/classes/asynczipdeflate.md b/docs/classes/asynczipdeflate.md new file mode 100644 index 0000000..e46b113 --- /dev/null +++ b/docs/classes/asynczipdeflate.md @@ -0,0 +1,182 @@ +# Class: AsyncZipDeflate + +Asynchronous streaming DEFLATE compression for ZIP archives + +## Hierarchy + +* **AsyncZipDeflate** + +## Implements + +* [ZipInputFile](../interfaces/zipinputfile.md) + +## Index + +### Constructors + +* [constructor](asynczipdeflate.md#constructor) + +### Properties + +* [attrs](asynczipdeflate.md#attrs) +* [comment](asynczipdeflate.md#comment) +* [compression](asynczipdeflate.md#compression) +* [crc](asynczipdeflate.md#crc) +* [extra](asynczipdeflate.md#extra) +* [filename](asynczipdeflate.md#filename) +* [flag](asynczipdeflate.md#flag) +* [mtime](asynczipdeflate.md#mtime) +* [ondata](asynczipdeflate.md#ondata) +* [os](asynczipdeflate.md#os) +* [size](asynczipdeflate.md#size) +* [terminate](asynczipdeflate.md#terminate) + +### Methods + +* [process](asynczipdeflate.md#process) +* [push](asynczipdeflate.md#push) + +## Constructors + +### constructor + +\+ **new AsyncZipDeflate**(`filename`: string, `opts?`: [DeflateOptions](../interfaces/deflateoptions.md)): [AsyncZipDeflate](asynczipdeflate.md) + +Creates a DEFLATE stream that can be added to ZIP archives + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`filename` | string | The filename to associate with this data stream | +`opts?` | [DeflateOptions](../interfaces/deflateoptions.md) | The compression options | + +**Returns:** [AsyncZipDeflate](asynczipdeflate.md) + +## Properties + +### attrs + +• `Optional` **attrs**: number + +*Implementation of [ZipInputFile](../interfaces/zipinputfile.md).[attrs](../interfaces/zipinputfile.md#attrs)* + +___ + +### comment + +• `Optional` **comment**: string + +*Implementation of [ZipInputFile](../interfaces/zipinputfile.md).[comment](../interfaces/zipinputfile.md#comment)* + +___ + +### compression + +• **compression**: number + +*Implementation of [ZipInputFile](../interfaces/zipinputfile.md).[compression](../interfaces/zipinputfile.md#compression)* + +___ + +### crc + +• **crc**: number + +*Implementation of [ZipInputFile](../interfaces/zipinputfile.md).[crc](../interfaces/zipinputfile.md#crc)* + +___ + +### extra + +• `Optional` **extra**: Record\<number, Uint8Array> + +*Implementation of [ZipInputFile](../interfaces/zipinputfile.md).[extra](../interfaces/zipinputfile.md#extra)* + +___ + +### filename + +• **filename**: string + +*Implementation of [ZipInputFile](../interfaces/zipinputfile.md).[filename](../interfaces/zipinputfile.md#filename)* + +___ + +### flag + +• **flag**: 0 \| 1 \| 2 \| 3 + +*Implementation of [ZipInputFile](../interfaces/zipinputfile.md).[flag](../interfaces/zipinputfile.md#flag)* + +___ + +### mtime + +• `Optional` **mtime**: GzipOptions[\"mtime\"] + +*Implementation of [ZipInputFile](../interfaces/zipinputfile.md).[mtime](../interfaces/zipinputfile.md#mtime)* + +___ + +### ondata + +• **ondata**: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) + +*Implementation of [ZipInputFile](../interfaces/zipinputfile.md).[ondata](../interfaces/zipinputfile.md#ondata)* + +___ + +### os + +• `Optional` **os**: number + +*Implementation of [ZipInputFile](../interfaces/zipinputfile.md).[os](../interfaces/zipinputfile.md#os)* + +___ + +### size + +• **size**: number + +*Implementation of [ZipInputFile](../interfaces/zipinputfile.md).[size](../interfaces/zipinputfile.md#size)* + +___ + +### terminate + +• **terminate**: [AsyncTerminable](../interfaces/asyncterminable.md) + +*Implementation of [ZipInputFile](../interfaces/zipinputfile.md).[terminate](../interfaces/zipinputfile.md#terminate)* + +## Methods + +### process + +▸ **process**(`chunk`: Uint8Array, `final`: boolean): void + +#### Parameters: + +Name | Type | +------ | ------ | +`chunk` | Uint8Array | +`final` | boolean | + +**Returns:** void + +___ + +### 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 |