blob: 66d1cf1636561e0dccd1564f92616a0642f13918 (
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
# Class: AsyncGzip
Asynchronous streaming GZIP compression
Asynchronous streaming GZIP compression
## Hierarchy
* **AsyncGzip**
## Index
### Constructors
* [constructor](asyncgzip.md#constructor)
### Properties
* [ondata](asyncgzip.md#ondata)
* [terminate](asyncgzip.md#terminate)
### Methods
* [push](asyncgzip.md#push)
## Constructors
### constructor
\+ **new AsyncGzip**(`opts`: [GzipOptions](../interfaces/gzipoptions.md), `cb?`: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler)): [AsyncGzip](asyncgzip.md)
Creates an asynchronous GZIP stream
#### Parameters:
Name | Type | Description |
------ | ------ | ------ |
`opts` | [GzipOptions](../interfaces/gzipoptions.md) | The compression options |
`cb?` | [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) | The callback to call whenever data is deflated |
**Returns:** [AsyncGzip](asyncgzip.md)
\+ **new AsyncGzip**(`cb?`: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler)): [AsyncGzip](asyncgzip.md)
Creates an asynchronous GZIP stream
#### Parameters:
Name | Type | Description |
------ | ------ | ------ |
`cb?` | [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) | The callback to call whenever data is deflated |
**Returns:** [AsyncGzip](asyncgzip.md)
\+ **new AsyncGzip**(`opts`: [GzipOptions](../interfaces/gzipoptions.md), `cb?`: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler)): [AsyncGzip](asyncgzip.md)
Creates an asynchronous GZIP stream
#### Parameters:
Name | Type | Description |
------ | ------ | ------ |
`opts` | [GzipOptions](../interfaces/gzipoptions.md) | The compression options |
`cb?` | [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) | The callback to call whenever data is deflated |
**Returns:** [AsyncGzip](asyncgzip.md)
\+ **new AsyncGzip**(`cb?`: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler)): [AsyncGzip](asyncgzip.md)
Creates an asynchronous GZIP stream
#### Parameters:
Name | Type | Description |
------ | ------ | ------ |
`cb?` | [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler) | The callback to call whenever data is deflated |
**Returns:** [AsyncGzip](asyncgzip.md)
## Properties
### ondata
• **ondata**: [AsyncFlateStreamHandler](../README.md#asyncflatestreamhandler)
The handler to call whenever data is available
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.
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
|
