diff options
Diffstat (limited to 'docs/classes/zippassthrough.md')
-rw-r--r-- | docs/classes/zippassthrough.md | 149 |
1 files changed, 149 insertions, 0 deletions
diff --git a/docs/classes/zippassthrough.md b/docs/classes/zippassthrough.md new file mode 100644 index 0000000..1c0d27d --- /dev/null +++ b/docs/classes/zippassthrough.md @@ -0,0 +1,149 @@ +# Class: ZipPassThrough + +A pass-through stream to keep data uncompressed in a ZIP archive. + +## Hierarchy + +* **ZipPassThrough** + +## Implements + +* [ZipInputFile](../interfaces/zipinputfile.md) + +## Index + +### Constructors + +* [constructor](zippassthrough.md#constructor) + +### Properties + +* [attrs](zippassthrough.md#attrs) +* [comment](zippassthrough.md#comment) +* [compression](zippassthrough.md#compression) +* [crc](zippassthrough.md#crc) +* [extra](zippassthrough.md#extra) +* [filename](zippassthrough.md#filename) +* [mtime](zippassthrough.md#mtime) +* [ondata](zippassthrough.md#ondata) +* [os](zippassthrough.md#os) +* [size](zippassthrough.md#size) + +### Methods + +* [push](zippassthrough.md#push) + +## Constructors + +### constructor + +\+ **new ZipPassThrough**(`filename`: string): [ZipPassThrough](zippassthrough.md) + +Creates a pass-through stream that can be added to ZIP archives + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`filename` | string | The filename to associate with this data stream | + +**Returns:** [ZipPassThrough](zippassthrough.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)* + +___ + +### 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 + +### push + +▸ **push**(`chunk`: Uint8Array, `final?`: boolean): void + +Pushes a chunk to be added. If you are subclassing this with a custom +compression algorithm, note that you must push data from the source +file only, pre-compression. + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`chunk` | Uint8Array | The chunk to push | +`final?` | boolean | Whether this is the last chunk | + +**Returns:** void |