asyncgzip.md 3.2 KB
Class: AsyncGzip
Asynchronous streaming GZIP compression Asynchronous streaming GZIP compression
Hierarchy
- AsyncGzip
Index
Constructors
Properties
Methods
Constructors
constructor
+ new AsyncGzip(opts: GzipOptions, cb?: AsyncFlateStreamHandler): AsyncGzip
Creates an asynchronous GZIP stream
Parameters:
| Name | Type | Description |
|---|---|---|
opts |
GzipOptions | The compression options |
cb? |
AsyncFlateStreamHandler | The callback to call whenever data is deflated |
Returns: AsyncGzip
+ new AsyncGzip(cb?: AsyncFlateStreamHandler): AsyncGzip
Creates an asynchronous GZIP stream
Parameters:
| Name | Type | Description |
|---|---|---|
cb? |
AsyncFlateStreamHandler | The callback to call whenever data is deflated |
Returns: AsyncGzip
+ new AsyncGzip(opts: GzipOptions, cb?: AsyncFlateStreamHandler): AsyncGzip
Creates an asynchronous GZIP stream
Parameters:
| Name | Type | Description |
|---|---|---|
opts |
GzipOptions | The compression options |
cb? |
AsyncFlateStreamHandler | The callback to call whenever data is deflated |
Returns: AsyncGzip
+ new AsyncGzip(cb?: AsyncFlateStreamHandler): AsyncGzip
Creates an asynchronous GZIP stream
Parameters:
| Name | Type | Description |
|---|---|---|
cb? |
AsyncFlateStreamHandler | The callback to call whenever data is deflated |
Returns: AsyncGzip
Properties
ondata
• ondata: AsyncFlateStreamHandler
The handler to call whenever data is available The handler to call whenever data is available
terminate
• terminate: AsyncTerminable
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