# 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