summaryrefslogtreecommitdiff
path: root/docs/classes/asyncunzlib.md
blob: 70d067d9c8cbf8512b5cc64e67965732f0aaceea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
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