deflate.md 1.5 KB
Class: Deflate
Streaming DEFLATE compression
Hierarchy
- Deflate
Index
Constructors
Properties
Methods
Constructors
constructor
+ new Deflate(opts: DeflateOptions, cb?: FlateStreamHandler): Deflate
Creates a DEFLATE stream
Parameters:
| Name | Type | Description |
|---|---|---|
opts |
DeflateOptions | The compression options |
cb? |
FlateStreamHandler | The callback to call whenever data is deflated |
Returns: Deflate
+ new Deflate(cb?: FlateStreamHandler): Deflate
Creates a DEFLATE stream
Parameters:
| Name | Type | Description |
|---|---|---|
cb? |
FlateStreamHandler | The callback to call whenever data is deflated |
Returns: Deflate
Properties
ondata
• ondata: 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