diff options
Diffstat (limited to 'fflate/docs/classes')
24 files changed, 2074 insertions, 0 deletions
diff --git a/fflate/docs/classes/asyncdecompress.md b/fflate/docs/classes/asyncdecompress.md new file mode 100644 index 0000000..9073472 --- /dev/null +++ b/fflate/docs/classes/asyncdecompress.md @@ -0,0 +1,62 @@ +# Class: AsyncDecompress + +Asynchronous streaming GZIP, Zlib, or raw DEFLATE decompression + +## Hierarchy + +* **AsyncDecompress** + +## Index + +### Constructors + +* [constructor](asyncdecompress.md#constructor) + +### Properties + +* [ondata](asyncdecompress.md#ondata) + +### Methods + +* [push](asyncdecompress.md#push) + +## Constructors + +### constructor + +\+ **new AsyncDecompress**(`cb?`: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler)): [AsyncDecompress](asyncdecompress.md) + +Creates an asynchronous decompression stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`cb?` | [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) | The callback to call whenever data is decompressed | + +**Returns:** [AsyncDecompress](asyncdecompress.md) + +## Properties + +### ondata + +• **ondata**: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) + +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 diff --git a/fflate/docs/classes/asyncdeflate.md b/fflate/docs/classes/asyncdeflate.md new file mode 100644 index 0000000..b4a36bf --- /dev/null +++ b/fflate/docs/classes/asyncdeflate.md @@ -0,0 +1,85 @@ +# Class: AsyncDeflate + +Asynchronous streaming DEFLATE compression + +## Hierarchy + +* **AsyncDeflate** + +## Index + +### Constructors + +* [constructor](asyncdeflate.md#constructor) + +### Properties + +* [ondata](asyncdeflate.md#ondata) +* [terminate](asyncdeflate.md#terminate) + +### Methods + +* [push](asyncdeflate.md#push) + +## Constructors + +### constructor + +\+ **new AsyncDeflate**(`opts`: [DeflateOptions](../interfaces/deflateoptions.md), `cb?`: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler)): [AsyncDeflate](asyncdeflate.md) + +Creates an asynchronous DEFLATE stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`opts` | [DeflateOptions](../interfaces/deflateoptions.md) | The compression options | +`cb?` | [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) | The callback to call whenever data is deflated | + +**Returns:** [AsyncDeflate](asyncdeflate.md) + +\+ **new AsyncDeflate**(`cb?`: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler)): [AsyncDeflate](asyncdeflate.md) + +Creates an asynchronous DEFLATE stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`cb?` | [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) | The callback to call whenever data is deflated | + +**Returns:** [AsyncDeflate](asyncdeflate.md) + +## Properties + +### ondata + +• **ondata**: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) + +The handler to call whenever data is available + +___ + +### terminate + +• **terminate**: [AsyncTerminable](../interfaces/asyncterminable.md) + +A method to terminate the stream's internal worker. Subsequent calls to +push() will silently fail. + +## 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 diff --git a/fflate/docs/classes/asyncgunzip.md b/fflate/docs/classes/asyncgunzip.md new file mode 100644 index 0000000..14c48ce --- /dev/null +++ b/fflate/docs/classes/asyncgunzip.md @@ -0,0 +1,72 @@ +# Class: AsyncGunzip + +Asynchronous streaming GZIP decompression + +## Hierarchy + +* **AsyncGunzip** + +## Index + +### Constructors + +* [constructor](asyncgunzip.md#constructor) + +### Properties + +* [ondata](asyncgunzip.md#ondata) +* [terminate](asyncgunzip.md#terminate) + +### Methods + +* [push](asyncgunzip.md#push) + +## Constructors + +### constructor + +\+ **new AsyncGunzip**(`cb?`: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler)): [AsyncGunzip](asyncgunzip.md) + +Creates an asynchronous GUNZIP stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`cb?` | [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) | The callback to call whenever data is deflated | + +**Returns:** [AsyncGunzip](asyncgunzip.md) + +## Properties + +### ondata + +• **ondata**: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) + +The handler to call whenever data is available + +___ + +### terminate + +• **terminate**: [AsyncTerminable](../interfaces/asyncterminable.md) + +A method to terminate the stream's internal worker. Subsequent calls to +push() will silently fail. + +## Methods + +### push + +▸ **push**(`chunk`: Uint8Array, `final?`: boolean): void + +Pushes a chunk to be GUNZIPped + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`chunk` | Uint8Array | The chunk to push | +`final?` | boolean | Whether this is the last chunk | + +**Returns:** void diff --git a/fflate/docs/classes/asyncgzip.md b/fflate/docs/classes/asyncgzip.md new file mode 100644 index 0000000..66d1cf1 --- /dev/null +++ b/fflate/docs/classes/asyncgzip.md @@ -0,0 +1,127 @@ +# Class: AsyncGzip + +Asynchronous streaming GZIP compression +Asynchronous streaming GZIP compression + +## Hierarchy + +* **AsyncGzip** + +## Index + +### Constructors + +* [constructor](asyncgzip.md#constructor) + +### Properties + +* [ondata](asyncgzip.md#ondata) +* [terminate](asyncgzip.md#terminate) + +### Methods + +* [push](asyncgzip.md#push) + +## Constructors + +### constructor + +\+ **new AsyncGzip**(`opts`: [GzipOptions](../interfaces/gzipoptions.md), `cb?`: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler)): [AsyncGzip](asyncgzip.md) + +Creates an asynchronous GZIP stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`opts` | [GzipOptions](../interfaces/gzipoptions.md) | The compression options | +`cb?` | [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) | The callback to call whenever data is deflated | + +**Returns:** [AsyncGzip](asyncgzip.md) + +\+ **new AsyncGzip**(`cb?`: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler)): [AsyncGzip](asyncgzip.md) + +Creates an asynchronous GZIP stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`cb?` | [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) | The callback to call whenever data is deflated | + +**Returns:** [AsyncGzip](asyncgzip.md) + +\+ **new AsyncGzip**(`opts`: [GzipOptions](../interfaces/gzipoptions.md), `cb?`: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler)): [AsyncGzip](asyncgzip.md) + +Creates an asynchronous GZIP stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`opts` | [GzipOptions](../interfaces/gzipoptions.md) | The compression options | +`cb?` | [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) | The callback to call whenever data is deflated | + +**Returns:** [AsyncGzip](asyncgzip.md) + +\+ **new AsyncGzip**(`cb?`: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler)): [AsyncGzip](asyncgzip.md) + +Creates an asynchronous GZIP stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`cb?` | [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) | The callback to call whenever data is deflated | + +**Returns:** [AsyncGzip](asyncgzip.md) + +## Properties + +### ondata + +• **ondata**: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) + +The handler to call whenever data is available +The handler to call whenever data is available + +___ + +### terminate + +• **terminate**: [AsyncTerminable](../interfaces/asyncterminable.md) + +A method to terminate the stream's internal worker. Subsequent calls to +push() will silently fail. +A method to terminate the stream's internal worker. Subsequent calls to +push() will silently fail. + +## Methods + +### push + +▸ **push**(`chunk`: Uint8Array, `final?`: boolean): void + +Pushes a chunk to be GZIPped + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`chunk` | Uint8Array | The chunk to push | +`final?` | boolean | Whether this is the last chunk | + +**Returns:** void + +▸ **push**(`chunk`: Uint8Array, `final?`: boolean): void + +Pushes a chunk to be GZIPped + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`chunk` | Uint8Array | The chunk to push | +`final?` | boolean | Whether this is the last chunk | + +**Returns:** void diff --git a/fflate/docs/classes/asyncinflate.md b/fflate/docs/classes/asyncinflate.md new file mode 100644 index 0000000..19b4266 --- /dev/null +++ b/fflate/docs/classes/asyncinflate.md @@ -0,0 +1,72 @@ +# Class: AsyncInflate + +Asynchronous streaming DEFLATE decompression + +## Hierarchy + +* **AsyncInflate** + +## Index + +### Constructors + +* [constructor](asyncinflate.md#constructor) + +### Properties + +* [ondata](asyncinflate.md#ondata) +* [terminate](asyncinflate.md#terminate) + +### Methods + +* [push](asyncinflate.md#push) + +## Constructors + +### constructor + +\+ **new AsyncInflate**(`cb?`: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler)): [AsyncInflate](asyncinflate.md) + +Creates an asynchronous inflation stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`cb?` | [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) | The callback to call whenever data is deflated | + +**Returns:** [AsyncInflate](asyncinflate.md) + +## Properties + +### ondata + +• **ondata**: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) + +The handler to call whenever data is available + +___ + +### terminate + +• **terminate**: [AsyncTerminable](../interfaces/asyncterminable.md) + +A method to terminate the stream's internal worker. Subsequent calls to +push() will silently fail. + +## Methods + +### push + +▸ **push**(`chunk`: Uint8Array, `final?`: boolean): void + +Pushes a chunk to be inflated + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`chunk` | Uint8Array | The chunk to push | +`final?` | boolean | Whether this is the last chunk | + +**Returns:** void diff --git a/fflate/docs/classes/asyncunzipinflate.md b/fflate/docs/classes/asyncunzipinflate.md new file mode 100644 index 0000000..befe5f1 --- /dev/null +++ b/fflate/docs/classes/asyncunzipinflate.md @@ -0,0 +1,83 @@ +# Class: AsyncUnzipInflate + +Asynchronous streaming DEFLATE decompression for ZIP archives + +## Hierarchy + +* **AsyncUnzipInflate** + +## Implements + +* [UnzipDecoder](../interfaces/unzipdecoder.md) + +## Index + +### Constructors + +* [constructor](asyncunzipinflate.md#constructor) + +### Properties + +* [ondata](asyncunzipinflate.md#ondata) +* [terminate](asyncunzipinflate.md#terminate) +* [compression](asyncunzipinflate.md#compression) + +### Methods + +* [push](asyncunzipinflate.md#push) + +## Constructors + +### constructor + +\+ **new AsyncUnzipInflate**(`_`: string, `sz?`: number): [AsyncUnzipInflate](asyncunzipinflate.md) + +Creates a DEFLATE decompression that can be used in ZIP archives + +#### Parameters: + +Name | Type | +------ | ------ | +`_` | string | +`sz?` | number | + +**Returns:** [AsyncUnzipInflate](asyncunzipinflate.md) + +## Properties + +### ondata + +• **ondata**: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) + +*Implementation of [UnzipDecoder](../interfaces/unzipdecoder.md).[ondata](../interfaces/unzipdecoder.md#ondata)* + +___ + +### terminate + +• **terminate**: [AsyncTerminable](../interfaces/asyncterminable.md) + +*Implementation of [UnzipDecoder](../interfaces/unzipdecoder.md).[terminate](../interfaces/unzipdecoder.md#terminate)* + +___ + +### compression + +▪ `Static` **compression**: number = 8 + +## Methods + +### push + +▸ **push**(`data`: Uint8Array, `final`: boolean): void + +*Implementation of [UnzipDecoder](../interfaces/unzipdecoder.md)* + +#### Parameters: + +Name | Type | +------ | ------ | +`data` | Uint8Array | +`final` | boolean | + +**Returns:** void diff --git a/fflate/docs/classes/asyncunzlib.md b/fflate/docs/classes/asyncunzlib.md new file mode 100644 index 0000000..70d067d --- /dev/null +++ b/fflate/docs/classes/asyncunzlib.md @@ -0,0 +1,72 @@ +# Class: AsyncUnzlib + +Asynchronous streaming Zlib decompression + +## Hierarchy + +* **AsyncUnzlib** + +## Index + +### Constructors + +* [constructor](asyncunzlib.md#constructor) + +### Properties + +* [ondata](asyncunzlib.md#ondata) +* [terminate](asyncunzlib.md#terminate) + +### Methods + +* [push](asyncunzlib.md#push) + +## Constructors + +### constructor + +\+ **new AsyncUnzlib**(`cb?`: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler)): [AsyncUnzlib](asyncunzlib.md) + +Creates an asynchronous Zlib decompression stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`cb?` | [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) | The callback to call whenever data is deflated | + +**Returns:** [AsyncUnzlib](asyncunzlib.md) + +## Properties + +### ondata + +• **ondata**: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) + +The handler to call whenever data is available + +___ + +### terminate + +• **terminate**: [AsyncTerminable](../interfaces/asyncterminable.md) + +A method to terminate the stream's internal worker. Subsequent calls to +push() will silently fail. + +## Methods + +### push + +▸ **push**(`chunk`: Uint8Array, `final?`: boolean): void + +Pushes a chunk to be decompressed from Zlib + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`chunk` | Uint8Array | The chunk to push | +`final?` | boolean | Whether this is the last chunk | + +**Returns:** void diff --git a/fflate/docs/classes/asynczipdeflate.md b/fflate/docs/classes/asynczipdeflate.md new file mode 100644 index 0000000..e46b113 --- /dev/null +++ b/fflate/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 diff --git a/fflate/docs/classes/asynczlib.md b/fflate/docs/classes/asynczlib.md new file mode 100644 index 0000000..f3975fc --- /dev/null +++ b/fflate/docs/classes/asynczlib.md @@ -0,0 +1,85 @@ +# Class: AsyncZlib + +Asynchronous streaming Zlib compression + +## Hierarchy + +* **AsyncZlib** + +## Index + +### Constructors + +* [constructor](asynczlib.md#constructor) + +### Properties + +* [ondata](asynczlib.md#ondata) +* [terminate](asynczlib.md#terminate) + +### Methods + +* [push](asynczlib.md#push) + +## Constructors + +### constructor + +\+ **new AsyncZlib**(`opts`: [ZlibOptions](../interfaces/zliboptions.md), `cb?`: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler)): [AsyncZlib](asynczlib.md) + +Creates an asynchronous DEFLATE stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`opts` | [ZlibOptions](../interfaces/zliboptions.md) | The compression options | +`cb?` | [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) | The callback to call whenever data is deflated | + +**Returns:** [AsyncZlib](asynczlib.md) + +\+ **new AsyncZlib**(`cb?`: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler)): [AsyncZlib](asynczlib.md) + +Creates an asynchronous DEFLATE stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`cb?` | [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) | The callback to call whenever data is deflated | + +**Returns:** [AsyncZlib](asynczlib.md) + +## Properties + +### ondata + +• **ondata**: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) + +The handler to call whenever data is available + +___ + +### terminate + +• **terminate**: [AsyncTerminable](../interfaces/asyncterminable.md) + +A method to terminate the stream's internal worker. Subsequent calls to +push() will silently fail. + +## 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 diff --git a/fflate/docs/classes/decodeutf8.md b/fflate/docs/classes/decodeutf8.md new file mode 100644 index 0000000..ca98064 --- /dev/null +++ b/fflate/docs/classes/decodeutf8.md @@ -0,0 +1,62 @@ +# Class: DecodeUTF8 + +Streaming UTF-8 decoding + +## Hierarchy + +* **DecodeUTF8** + +## Index + +### Constructors + +* [constructor](decodeutf8.md#constructor) + +### Properties + +* [ondata](decodeutf8.md#ondata) + +### Methods + +* [push](decodeutf8.md#push) + +## Constructors + +### constructor + +\+ **new DecodeUTF8**(`cb?`: [StringStreamHandler](../README.md#stringstreamhandler)): [DecodeUTF8](decodeutf8.md) + +Creates a UTF-8 decoding stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`cb?` | [StringStreamHandler](../README.md#stringstreamhandler) | The callback to call whenever data is decoded | + +**Returns:** [DecodeUTF8](decodeutf8.md) + +## Properties + +### ondata + +• **ondata**: [StringStreamHandler](../README.md#stringstreamhandler) + +The handler to call whenever data is available + +## Methods + +### push + +▸ **push**(`chunk`: Uint8Array, `final?`: boolean): void + +Pushes a chunk to be decoded from UTF-8 binary + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`chunk` | Uint8Array | The chunk to push | +`final?` | boolean | Whether this is the last chunk | + +**Returns:** void diff --git a/fflate/docs/classes/decompress.md b/fflate/docs/classes/decompress.md new file mode 100644 index 0000000..0e45e5b --- /dev/null +++ b/fflate/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 diff --git a/fflate/docs/classes/deflate.md b/fflate/docs/classes/deflate.md new file mode 100644 index 0000000..3b9195a --- /dev/null +++ b/fflate/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 diff --git a/fflate/docs/classes/encodeutf8.md b/fflate/docs/classes/encodeutf8.md new file mode 100644 index 0000000..3fd2c4b --- /dev/null +++ b/fflate/docs/classes/encodeutf8.md @@ -0,0 +1,62 @@ +# Class: EncodeUTF8 + +Streaming UTF-8 encoding + +## Hierarchy + +* **EncodeUTF8** + +## Index + +### Constructors + +* [constructor](encodeutf8.md#constructor) + +### Properties + +* [ondata](encodeutf8.md#ondata) + +### Methods + +* [push](encodeutf8.md#push) + +## Constructors + +### constructor + +\+ **new EncodeUTF8**(`cb?`: [FlateStreamHandler](../README.md#flatestreamhandler)): [EncodeUTF8](encodeutf8.md) + +Creates a UTF-8 decoding stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`cb?` | [FlateStreamHandler](../README.md#flatestreamhandler) | The callback to call whenever data is encoded | + +**Returns:** [EncodeUTF8](encodeutf8.md) + +## Properties + +### ondata + +• **ondata**: [FlateStreamHandler](../README.md#flatestreamhandler) + +The handler to call whenever data is available + +## Methods + +### push + +▸ **push**(`chunk`: string, `final?`: boolean): void + +Pushes a chunk to be encoded to UTF-8 + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`chunk` | string | The string data to push | +`final?` | boolean | Whether this is the last chunk | + +**Returns:** void diff --git a/fflate/docs/classes/gunzip.md b/fflate/docs/classes/gunzip.md new file mode 100644 index 0000000..8299350 --- /dev/null +++ b/fflate/docs/classes/gunzip.md @@ -0,0 +1,62 @@ +# Class: Gunzip + +Streaming GZIP decompression + +## Hierarchy + +* **Gunzip** + +## Index + +### Constructors + +* [constructor](gunzip.md#constructor) + +### Properties + +* [ondata](gunzip.md#ondata) + +### Methods + +* [push](gunzip.md#push) + +## Constructors + +### constructor + +\+ **new Gunzip**(`cb?`: [FlateStreamHandler](../README.md#flatestreamhandler)): [Gunzip](gunzip.md) + +Creates a GUNZIP stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`cb?` | [FlateStreamHandler](../README.md#flatestreamhandler) | The callback to call whenever data is inflated | + +**Returns:** [Gunzip](gunzip.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 GUNZIPped + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`chunk` | Uint8Array | The chunk to push | +`final?` | boolean | Whether this is the last chunk | + +**Returns:** void diff --git a/fflate/docs/classes/gzip.md b/fflate/docs/classes/gzip.md new file mode 100644 index 0000000..2cbc2a1 --- /dev/null +++ b/fflate/docs/classes/gzip.md @@ -0,0 +1,102 @@ +# Class: Gzip + +Streaming GZIP compression +Streaming GZIP compression + +## Hierarchy + +* **Gzip** + +## Index + +### Constructors + +* [constructor](gzip.md#constructor) + +### Properties + +* [ondata](gzip.md#ondata) + +### Methods + +* [push](gzip.md#push) + +## Constructors + +### constructor + +\+ **new Gzip**(`opts`: [GzipOptions](../interfaces/gzipoptions.md), `cb?`: [FlateStreamHandler](../README.md#flatestreamhandler)): [Gzip](gzip.md) + +Creates a GZIP stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`opts` | [GzipOptions](../interfaces/gzipoptions.md) | The compression options | +`cb?` | [FlateStreamHandler](../README.md#flatestreamhandler) | The callback to call whenever data is deflated | + +**Returns:** [Gzip](gzip.md) + +\+ **new Gzip**(`cb?`: [FlateStreamHandler](../README.md#flatestreamhandler)): [Gzip](gzip.md) + +Creates a GZIP stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`cb?` | [FlateStreamHandler](../README.md#flatestreamhandler) | The callback to call whenever data is deflated | + +**Returns:** [Gzip](gzip.md) + +\+ **new Gzip**(`opts`: [GzipOptions](../interfaces/gzipoptions.md), `cb?`: [FlateStreamHandler](../README.md#flatestreamhandler)): [Gzip](gzip.md) + +Creates a GZIP stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`opts` | [GzipOptions](../interfaces/gzipoptions.md) | The compression options | +`cb?` | [FlateStreamHandler](../README.md#flatestreamhandler) | The callback to call whenever data is deflated | + +**Returns:** [Gzip](gzip.md) + +\+ **new Gzip**(`cb?`: [FlateStreamHandler](../README.md#flatestreamhandler)): [Gzip](gzip.md) + +Creates a GZIP stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`cb?` | [FlateStreamHandler](../README.md#flatestreamhandler) | The callback to call whenever data is deflated | + +**Returns:** [Gzip](gzip.md) + +## Properties + +### ondata + +• **ondata**: [FlateStreamHandler](../README.md#flatestreamhandler) + +The handler to call whenever data is available +The handler to call whenever data is available + +## Methods + +### push + +▸ **push**(`chunk`: Uint8Array, `final?`: boolean): void + +Pushes a chunk to be GZIPped + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`chunk` | Uint8Array | The chunk to push | +`final?` | boolean | Whether this is the last chunk | + +**Returns:** void diff --git a/fflate/docs/classes/inflate.md b/fflate/docs/classes/inflate.md new file mode 100644 index 0000000..72cdcba --- /dev/null +++ b/fflate/docs/classes/inflate.md @@ -0,0 +1,62 @@ +# Class: Inflate + +Streaming DEFLATE decompression + +## Hierarchy + +* **Inflate** + +## Index + +### Constructors + +* [constructor](inflate.md#constructor) + +### Properties + +* [ondata](inflate.md#ondata) + +### Methods + +* [push](inflate.md#push) + +## Constructors + +### constructor + +\+ **new Inflate**(`cb?`: [FlateStreamHandler](../README.md#flatestreamhandler)): [Inflate](inflate.md) + +Creates an inflation stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`cb?` | [FlateStreamHandler](../README.md#flatestreamhandler) | The callback to call whenever data is inflated | + +**Returns:** [Inflate](inflate.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 inflated + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`chunk` | Uint8Array | The chunk to push | +`final?` | boolean | Whether this is the final chunk | + +**Returns:** void diff --git a/fflate/docs/classes/unzip.md b/fflate/docs/classes/unzip.md new file mode 100644 index 0000000..d0f8292 --- /dev/null +++ b/fflate/docs/classes/unzip.md @@ -0,0 +1,80 @@ +# Class: Unzip + +A ZIP archive decompression stream that emits files as they are discovered + +## Hierarchy + +* **Unzip** + +## Index + +### Constructors + +* [constructor](unzip.md#constructor) + +### Properties + +* [onfile](unzip.md#onfile) + +### Methods + +* [push](unzip.md#push) +* [register](unzip.md#register) + +## Constructors + +### constructor + +\+ **new Unzip**(`cb?`: [UnzipFileHandler](../README.md#unzipfilehandler)): [Unzip](unzip.md) + +Creates a ZIP decompression stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`cb?` | [UnzipFileHandler](../README.md#unzipfilehandler) | The callback to call whenever a file in the ZIP archive is found | + +**Returns:** [Unzip](unzip.md) + +## Properties + +### onfile + +• **onfile**: [UnzipFileHandler](../README.md#unzipfilehandler) + +The handler to call whenever a file is discovered + +## Methods + +### push + +▸ **push**(`chunk`: Uint8Array, `final?`: boolean): any + +Pushes a chunk to be unzipped + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`chunk` | Uint8Array | The chunk to push | +`final?` | boolean | Whether this is the last chunk | + +**Returns:** any + +___ + +### register + +▸ **register**(`decoder`: [UnzipDecoderConstructor](../interfaces/unzipdecoderconstructor.md)): void + +Registers a decoder with the stream, allowing for files compressed with +the compression type provided to be expanded correctly + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`decoder` | [UnzipDecoderConstructor](../interfaces/unzipdecoderconstructor.md) | The decoder constructor | + +**Returns:** void diff --git a/fflate/docs/classes/unzipinflate.md b/fflate/docs/classes/unzipinflate.md new file mode 100644 index 0000000..0da5623 --- /dev/null +++ b/fflate/docs/classes/unzipinflate.md @@ -0,0 +1,68 @@ +# Class: UnzipInflate + +Streaming DEFLATE decompression for ZIP archives. Prefer AsyncZipInflate for +better performance. + +## Hierarchy + +* **UnzipInflate** + +## Implements + +* [UnzipDecoder](../interfaces/unzipdecoder.md) + +## Index + +### Constructors + +* [constructor](unzipinflate.md#constructor) + +### Properties + +* [ondata](unzipinflate.md#ondata) +* [compression](unzipinflate.md#compression) + +### Methods + +* [push](unzipinflate.md#push) + +## Constructors + +### constructor + +\+ **new UnzipInflate**(): [UnzipInflate](unzipinflate.md) + +Creates a DEFLATE decompression that can be used in ZIP archives + +**Returns:** [UnzipInflate](unzipinflate.md) + +## Properties + +### ondata + +• **ondata**: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) + +*Implementation of [UnzipDecoder](../interfaces/unzipdecoder.md).[ondata](../interfaces/unzipdecoder.md#ondata)* + +___ + +### compression + +▪ `Static` **compression**: number = 8 + +## Methods + +### push + +▸ **push**(`data`: Uint8Array, `final`: boolean): void + +*Implementation of [UnzipDecoder](../interfaces/unzipdecoder.md)* + +#### Parameters: + +Name | Type | +------ | ------ | +`data` | Uint8Array | +`final` | boolean | + +**Returns:** void diff --git a/fflate/docs/classes/unzippassthrough.md b/fflate/docs/classes/unzippassthrough.md new file mode 100644 index 0000000..5e59eb9 --- /dev/null +++ b/fflate/docs/classes/unzippassthrough.md @@ -0,0 +1,53 @@ +# Class: UnzipPassThrough + +Streaming pass-through decompression for ZIP archives + +## Hierarchy + +* **UnzipPassThrough** + +## Implements + +* [UnzipDecoder](../interfaces/unzipdecoder.md) + +## Index + +### Properties + +* [ondata](unzippassthrough.md#ondata) +* [compression](unzippassthrough.md#compression) + +### Methods + +* [push](unzippassthrough.md#push) + +## Properties + +### ondata + +• **ondata**: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) + +*Implementation of [UnzipDecoder](../interfaces/unzipdecoder.md).[ondata](../interfaces/unzipdecoder.md#ondata)* + +___ + +### compression + +▪ `Static` **compression**: number = 0 + +## Methods + +### push + +▸ **push**(`data`: Uint8Array, `final`: boolean): void + +*Implementation of [UnzipDecoder](../interfaces/unzipdecoder.md)* + +#### Parameters: + +Name | Type | +------ | ------ | +`data` | Uint8Array | +`final` | boolean | + +**Returns:** void diff --git a/fflate/docs/classes/unzlib.md b/fflate/docs/classes/unzlib.md new file mode 100644 index 0000000..a64774b --- /dev/null +++ b/fflate/docs/classes/unzlib.md @@ -0,0 +1,62 @@ +# Class: Unzlib + +Streaming Zlib decompression + +## Hierarchy + +* **Unzlib** + +## Index + +### Constructors + +* [constructor](unzlib.md#constructor) + +### Properties + +* [ondata](unzlib.md#ondata) + +### Methods + +* [push](unzlib.md#push) + +## Constructors + +### constructor + +\+ **new Unzlib**(`cb?`: [FlateStreamHandler](../README.md#flatestreamhandler)): [Unzlib](unzlib.md) + +Creates a Zlib decompression stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`cb?` | [FlateStreamHandler](../README.md#flatestreamhandler) | The callback to call whenever data is inflated | + +**Returns:** [Unzlib](unzlib.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 unzlibbed + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`chunk` | Uint8Array | The chunk to push | +`final?` | boolean | Whether this is the last chunk | + +**Returns:** void diff --git a/fflate/docs/classes/zip.md b/fflate/docs/classes/zip.md new file mode 100644 index 0000000..a1aeee7 --- /dev/null +++ b/fflate/docs/classes/zip.md @@ -0,0 +1,86 @@ +# Class: Zip + +A zippable archive to which files can incrementally be added + +## Hierarchy + +* **Zip** + +## Index + +### Constructors + +* [constructor](zip.md#constructor) + +### Properties + +* [ondata](zip.md#ondata) + +### Methods + +* [add](zip.md#add) +* [end](zip.md#end) +* [terminate](zip.md#terminate) + +## Constructors + +### constructor + +\+ **new Zip**(`cb?`: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler)): [Zip](zip.md) + +Creates an empty ZIP archive to which files can be added + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`cb?` | [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) | The callback to call whenever data for the generated ZIP archive is available | + +**Returns:** [Zip](zip.md) + +## Properties + +### ondata + +• **ondata**: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) + +The handler to call whenever data is available + +## Methods + +### add + +▸ **add**(`file`: [ZipInputFile](../interfaces/zipinputfile.md)): void + +Adds a file to the ZIP archive + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`file` | [ZipInputFile](../interfaces/zipinputfile.md) | The file stream to add | + +**Returns:** void + +___ + +### end + +▸ **end**(): void + +Ends the process of adding files and prepares to emit the final chunks. +This *must* be called after adding all desired files for the resulting +ZIP file to work properly. + +**Returns:** void + +___ + +### terminate + +▸ **terminate**(): void + +A method to terminate any internal workers used by the stream. Subsequent +calls to add() will fail. + +**Returns:** void 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 diff --git a/fflate/docs/classes/zippassthrough.md b/fflate/docs/classes/zippassthrough.md new file mode 100644 index 0000000..1c0d27d --- /dev/null +++ b/fflate/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 diff --git a/fflate/docs/classes/zlib.md b/fflate/docs/classes/zlib.md new file mode 100644 index 0000000..33537d6 --- /dev/null +++ b/fflate/docs/classes/zlib.md @@ -0,0 +1,75 @@ +# Class: Zlib + +Streaming Zlib compression + +## Hierarchy + +* **Zlib** + +## Index + +### Constructors + +* [constructor](zlib.md#constructor) + +### Properties + +* [ondata](zlib.md#ondata) + +### Methods + +* [push](zlib.md#push) + +## Constructors + +### constructor + +\+ **new Zlib**(`opts`: [ZlibOptions](../interfaces/zliboptions.md), `cb?`: [FlateStreamHandler](../README.md#flatestreamhandler)): [Zlib](zlib.md) + +Creates a Zlib stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`opts` | [ZlibOptions](../interfaces/zliboptions.md) | The compression options | +`cb?` | [FlateStreamHandler](../README.md#flatestreamhandler) | The callback to call whenever data is deflated | + +**Returns:** [Zlib](zlib.md) + +\+ **new Zlib**(`cb?`: [FlateStreamHandler](../README.md#flatestreamhandler)): [Zlib](zlib.md) + +Creates a Zlib stream + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`cb?` | [FlateStreamHandler](../README.md#flatestreamhandler) | The callback to call whenever data is deflated | + +**Returns:** [Zlib](zlib.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 zlibbed + +#### Parameters: + +Name | Type | Description | +------ | ------ | ------ | +`chunk` | Uint8Array | The chunk to push | +`final?` | boolean | Whether this is the last chunk | + +**Returns:** void |