diff options
Diffstat (limited to 'fflate/docs/classes/zipdeflate.md')
-rw-r--r-- | fflate/docs/classes/zipdeflate.md | 174 |
1 files changed, 174 insertions, 0 deletions
diff --git a/fflate/docs/classes/zipdeflate.md b/fflate/docs/classes/zipdeflate.md new file mode 100644 index 0000000..0646989 --- /dev/null +++ b/fflate/docs/classes/zipdeflate.md @@ -0,0 +1,174 @@ +# Class: ZipDeflate + +Streaming DEFLATE compression for ZIP archives. Prefer using AsyncZipDeflate +for better performance + +## Hierarchy + +* **ZipDeflate** + +## Implements + +* [ZipInputFile](../interfaces/zipinputfile.md) + +## Index + +### Constructors + +* [constructor](zipdeflate.md#constructor) + +### Properties + +* [attrs](zipdeflate.md#attrs) +* [comment](zipdeflate.md#comment) +* [compression](zipdeflate.md#compression) +* [crc](zipdeflate.md#crc) +* [extra](zipdeflate.md#extra) +* [filename](zipdeflate.md#filename) +* [flag](zipdeflate.md#flag) +* [mtime](zipdeflate.md#mtime) +* [ondata](zipdeflate.md#ondata) +* [os](zipdeflate.md#os) +* [size](zipdeflate.md#size) + +### Methods + +* [process](zipdeflate.md#process) +* [push](zipdeflate.md#push) + +## Constructors + +### constructor + +\+ **new ZipDeflate**(`filename`: string, `opts?`: [DeflateOptions](../interfaces/deflateoptions.md)): [ZipDeflate](zipdeflate.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:** [ZipDeflate](zipdeflate.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)* + +## 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 |