blob: 2cbc2a13236df67eb10a43b8db76d8602ebe5e8f (
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
|
# Class: Gzip
Streaming GZIP compression
Streaming GZIP compression
## Hierarchy
* **Gzip**
## Index
### Constructors
* [constructor](gzip.md#constructor)
### Properties
* [ondata](gzip.md#ondata)
### Methods
* [push](gzip.md#push)
## Constructors
### constructor
\+ **new Gzip**(`opts`: [GzipOptions](../interfaces/gzipoptions.md), `cb?`: [FlateStreamHandler](../README.md#flatestreamhandler)): [Gzip](gzip.md)
Creates a GZIP stream
#### Parameters:
Name | Type | Description |
------ | ------ | ------ |
`opts` | [GzipOptions](../interfaces/gzipoptions.md) | The compression options |
`cb?` | [FlateStreamHandler](../README.md#flatestreamhandler) | The callback to call whenever data is deflated |
**Returns:** [Gzip](gzip.md)
\+ **new Gzip**(`cb?`: [FlateStreamHandler](../README.md#flatestreamhandler)): [Gzip](gzip.md)
Creates a GZIP stream
#### Parameters:
Name | Type | Description |
------ | ------ | ------ |
`cb?` | [FlateStreamHandler](../README.md#flatestreamhandler) | The callback to call whenever data is deflated |
**Returns:** [Gzip](gzip.md)
\+ **new Gzip**(`opts`: [GzipOptions](../interfaces/gzipoptions.md), `cb?`: [FlateStreamHandler](../README.md#flatestreamhandler)): [Gzip](gzip.md)
Creates a GZIP stream
#### Parameters:
Name | Type | Description |
------ | ------ | ------ |
`opts` | [GzipOptions](../interfaces/gzipoptions.md) | The compression options |
`cb?` | [FlateStreamHandler](../README.md#flatestreamhandler) | The callback to call whenever data is deflated |
**Returns:** [Gzip](gzip.md)
\+ **new Gzip**(`cb?`: [FlateStreamHandler](../README.md#flatestreamhandler)): [Gzip](gzip.md)
Creates a GZIP stream
#### Parameters:
Name | Type | Description |
------ | ------ | ------ |
`cb?` | [FlateStreamHandler](../README.md#flatestreamhandler) | The callback to call whenever data is deflated |
**Returns:** [Gzip](gzip.md)
## Properties
### ondata
• **ondata**: [FlateStreamHandler](../README.md#flatestreamhandler)
The handler to call whenever data is available
The handler to call whenever data is available
## 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
|
