asyncdeflate.md 2.4 KB
Class: AsyncDeflate
Asynchronous streaming DEFLATE compression
Hierarchy
- AsyncCmpStrm<DeflateOptions>
↳ AsyncDeflate
Index
Constructors
Properties
Methods
Constructors
constructor
+ new AsyncDeflate(opts: DeflateOptions, cb?: AsyncFlateStreamHandler): AsyncDeflate
Inherited from AsyncDeflate.constructor
Overrides AsyncInflate.constructor
Creates an asynchronous compression stream
Parameters:
| Name | Type | Description |
|---|---|---|
opts |
DeflateOptions | The compression options |
cb? |
AsyncFlateStreamHandler | The callback to call whenever data is deflated |
Returns: AsyncDeflate
+ new AsyncDeflate(cb?: AsyncFlateStreamHandler): AsyncDeflate
Inherited from AsyncDeflate.constructor
Overrides AsyncInflate.constructor
Creates an asynchronous compression stream
Parameters:
| Name | Type | Description |
|---|---|---|
cb? |
AsyncFlateStreamHandler | The callback to call whenever data is deflated |
Returns: AsyncDeflate
Properties
ondata
• ondata: AsyncFlateStreamHandler
Inherited from AsyncDeflate.ondata
The handler to call whenever data is available
Methods
push
▸ push(chunk: Uint8Array, final?: boolean): void
Inherited from AsyncDeflate.push
Overrides AsyncInflate.push
Pushes a chunk to be deflated
Parameters:
| Name | Type | Description |
|---|---|---|
chunk |
Uint8Array | The chunk to push |
final? |
boolean | Whether this is the final chunk |
Returns: void