Skip to content

Commit 9db54d4

Browse files
gameromangameroman
authored
🤖 Merge PR DefinitelyTyped#74552 Update node zlib types by @gameroman 
1 parent cce9617 commit 9db54d4

5 files changed

Lines changed: 274 additions & 16 deletions

File tree

‎types/node/node-tests/zlib.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import {
1313
createZstdCompress,
1414
createZstdDecompress,
1515
deflate,
16+
DeflateRaw,
1617
deflateRaw,
1718
deflateRawSync,
1819
deflateSync,
@@ -26,6 +27,7 @@ import {
2627
inflateSync,
2728
unzip,
2829
unzipSync,
30+
ZlibOptions,
2931
zstdCompress,
3032
zstdCompressSync,
3133
zstdDecompress,
@@ -95,6 +97,12 @@ deflateRaw(
9597
const inflatedRaw: Buffer = inflateRawSync(deflateRawSync(compressMe));
9698
const inflatedRawString: Buffer = inflateRawSync(deflateRawSync(compressMeString));
9799

100+
class CustomDeflateRaw extends DeflateRaw {
101+
constructor(options?: ZlibOptions) {
102+
super(options);
103+
}
104+
}
105+
98106
// gzip
99107

100108
gzip(compressMe, (err: Error | null, result: Buffer) => gunzip(result, (err: Error | null, result: Buffer) => result));

‎types/node/v20/zlib.d.ts‎

Lines changed: 62 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,14 @@ declare module "zlib" {
108108
*/
109109
chunkSize?: number | undefined;
110110
windowBits?: number | undefined;
111-
level?: number | undefined; // compression only
112-
memLevel?: number | undefined; // compression only
113-
strategy?: number | undefined; // compression only
114-
dictionary?: NodeJS.ArrayBufferView | ArrayBuffer | undefined; // deflate/inflate only, empty dictionary by default
111+
/** compression only */
112+
level?: number | undefined;
113+
/** compression only */
114+
memLevel?: number | undefined;
115+
/** compression only */
116+
strategy?: number | undefined;
117+
/** deflate/inflate only, empty dictionary by default */
118+
dictionary?: NodeJS.ArrayBufferView | ArrayBuffer | undefined;
115119
/**
116120
* If `true`, returns an object with `buffer` and `engine`.
117121
*/
@@ -164,14 +168,68 @@ declare module "zlib" {
164168
interface ZlibReset {
165169
reset(): void;
166170
}
171+
/**
172+
* @since v10.16.0
173+
*/
174+
class BrotliCompress extends stream.Transform {
175+
constructor(options?: BrotliOptions);
176+
}
167177
interface BrotliCompress extends stream.Transform, Zlib {}
178+
/**
179+
* @since v10.16.0
180+
*/
181+
class BrotliDecompress extends stream.Transform {
182+
constructor(options?: BrotliOptions);
183+
}
168184
interface BrotliDecompress extends stream.Transform, Zlib {}
185+
/**
186+
* @since v0.5.8
187+
*/
188+
class Gzip extends stream.Transform {
189+
constructor(options?: ZlibOptions);
190+
}
169191
interface Gzip extends stream.Transform, Zlib {}
192+
/**
193+
* @since v0.5.8
194+
*/
195+
class Gunzip extends stream.Transform {
196+
constructor(options?: ZlibOptions);
197+
}
170198
interface Gunzip extends stream.Transform, Zlib {}
199+
/**
200+
* @since v0.5.8
201+
*/
202+
class Deflate extends stream.Transform {
203+
constructor(options?: ZlibOptions);
204+
}
171205
interface Deflate extends stream.Transform, Zlib, ZlibReset, ZlibParams {}
206+
/**
207+
* @since v0.5.8
208+
*/
209+
class Inflate extends stream.Transform {
210+
constructor(options?: ZlibOptions);
211+
}
172212
interface Inflate extends stream.Transform, Zlib, ZlibReset {}
213+
/**
214+
* @since v0.5.8
215+
*/
216+
class DeflateRaw extends stream.Transform {
217+
constructor(options?: ZlibOptions);
218+
}
173219
interface DeflateRaw extends stream.Transform, Zlib, ZlibReset, ZlibParams {}
220+
/**
221+
* @since v0.5.8
222+
*/
223+
class InflateRaw extends stream.Transform {
224+
constructor(options?: ZlibOptions);
225+
}
174226
interface InflateRaw extends stream.Transform, Zlib, ZlibReset {}
227+
/**
228+
* @since v0.5.8
229+
*/
230+
class Unzip extends stream.Transform {
231+
constructor(options?: ZlibOptions);
232+
}
175233
interface Unzip extends stream.Transform, Zlib {}
176234
/**
177235
* Computes a 32-bit [Cyclic Redundancy Check](https://en.wikipedia.org/wiki/Cyclic_redundancy_check) checksum of `data`.

‎types/node/v22/zlib.d.ts‎

Lines changed: 68 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,14 @@ declare module "zlib" {
108108
*/
109109
chunkSize?: number | undefined;
110110
windowBits?: number | undefined;
111-
level?: number | undefined; // compression only
112-
memLevel?: number | undefined; // compression only
113-
strategy?: number | undefined; // compression only
114-
dictionary?: NodeJS.ArrayBufferView | ArrayBuffer | undefined; // deflate/inflate only, empty dictionary by default
111+
/** compression only */
112+
level?: number | undefined;
113+
/** compression only */
114+
memLevel?: number | undefined;
115+
/** compression only */
116+
strategy?: number | undefined;
117+
/** deflate/inflate only, empty dictionary by default */
118+
dictionary?: NodeJS.ArrayBufferView | ArrayBuffer | undefined;
115119
/**
116120
* If `true`, returns an object with `buffer` and `engine`.
117121
*/
@@ -203,24 +207,84 @@ declare module "zlib" {
203207
interface ZlibReset {
204208
reset(): void;
205209
}
210+
/**
211+
* @since v10.16.0
212+
*/
213+
class BrotliCompress extends stream.Transform {
214+
constructor(options?: BrotliOptions);
215+
}
206216
interface BrotliCompress extends stream.Transform, Zlib {}
217+
/**
218+
* @since v10.16.0
219+
*/
220+
class BrotliDecompress extends stream.Transform {
221+
constructor(options?: BrotliOptions);
222+
}
207223
interface BrotliDecompress extends stream.Transform, Zlib {}
224+
/**
225+
* @since v0.5.8
226+
*/
227+
class Gzip extends stream.Transform {
228+
constructor(options?: ZlibOptions);
229+
}
208230
interface Gzip extends stream.Transform, Zlib {}
231+
/**
232+
* @since v0.5.8
233+
*/
234+
class Gunzip extends stream.Transform {
235+
constructor(options?: ZlibOptions);
236+
}
209237
interface Gunzip extends stream.Transform, Zlib {}
238+
/**
239+
* @since v0.5.8
240+
*/
241+
class Deflate extends stream.Transform {
242+
constructor(options?: ZlibOptions);
243+
}
210244
interface Deflate extends stream.Transform, Zlib, ZlibReset, ZlibParams {}
245+
/**
246+
* @since v0.5.8
247+
*/
248+
class Inflate extends stream.Transform {
249+
constructor(options?: ZlibOptions);
250+
}
211251
interface Inflate extends stream.Transform, Zlib, ZlibReset {}
252+
/**
253+
* @since v0.5.8
254+
*/
255+
class DeflateRaw extends stream.Transform {
256+
constructor(options?: ZlibOptions);
257+
}
212258
interface DeflateRaw extends stream.Transform, Zlib, ZlibReset, ZlibParams {}
259+
/**
260+
* @since v0.5.8
261+
*/
262+
class InflateRaw extends stream.Transform {
263+
constructor(options?: ZlibOptions);
264+
}
213265
interface InflateRaw extends stream.Transform, Zlib, ZlibReset {}
266+
/**
267+
* @since v0.5.8
268+
*/
269+
class Unzip extends stream.Transform {
270+
constructor(options?: ZlibOptions);
271+
}
214272
interface Unzip extends stream.Transform, Zlib {}
215273
/**
216274
* @since v22.15.0
217275
* @experimental
218276
*/
277+
class ZstdCompress extends stream.Transform {
278+
constructor(options?: ZstdOptions);
279+
}
219280
interface ZstdCompress extends stream.Transform, Zlib {}
220281
/**
221282
* @since v22.15.0
222283
* @experimental
223284
*/
285+
class ZstdDecompress extends stream.Transform {
286+
constructor(options?: ZstdOptions);
287+
}
224288
interface ZstdDecompress extends stream.Transform, Zlib {}
225289
/**
226290
* Computes a 32-bit [Cyclic Redundancy Check](https://en.wikipedia.org/wiki/Cyclic_redundancy_check) checksum of `data`.

‎types/node/v24/zlib.d.ts‎

Lines changed: 68 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,14 @@ declare module "zlib" {
108108
*/
109109
chunkSize?: number | undefined;
110110
windowBits?: number | undefined;
111-
level?: number | undefined; // compression only
112-
memLevel?: number | undefined; // compression only
113-
strategy?: number | undefined; // compression only
114-
dictionary?: NodeJS.ArrayBufferView | ArrayBuffer | undefined; // deflate/inflate only, empty dictionary by default
111+
/** compression only */
112+
level?: number | undefined;
113+
/** compression only */
114+
memLevel?: number | undefined;
115+
/** compression only */
116+
strategy?: number | undefined;
117+
/** deflate/inflate only, empty dictionary by default */
118+
dictionary?: NodeJS.ArrayBufferView | ArrayBuffer | undefined;
115119
/**
116120
* If `true`, returns an object with `buffer` and `engine`.
117121
*/
@@ -201,24 +205,84 @@ declare module "zlib" {
201205
interface ZlibReset {
202206
reset(): void;
203207
}
208+
/**
209+
* @since v10.16.0
210+
*/
211+
class BrotliCompress extends stream.Transform {
212+
constructor(options?: BrotliOptions);
213+
}
204214
interface BrotliCompress extends stream.Transform, Zlib {}
215+
/**
216+
* @since v10.16.0
217+
*/
218+
class BrotliDecompress extends stream.Transform {
219+
constructor(options?: BrotliOptions);
220+
}
205221
interface BrotliDecompress extends stream.Transform, Zlib {}
222+
/**
223+
* @since v0.5.8
224+
*/
225+
class Gzip extends stream.Transform {
226+
constructor(options?: ZlibOptions);
227+
}
206228
interface Gzip extends stream.Transform, Zlib {}
229+
/**
230+
* @since v0.5.8
231+
*/
232+
class Gunzip extends stream.Transform {
233+
constructor(options?: ZlibOptions);
234+
}
207235
interface Gunzip extends stream.Transform, Zlib {}
236+
/**
237+
* @since v0.5.8
238+
*/
239+
class Deflate extends stream.Transform {
240+
constructor(options?: ZlibOptions);
241+
}
208242
interface Deflate extends stream.Transform, Zlib, ZlibReset, ZlibParams {}
243+
/**
244+
* @since v0.5.8
245+
*/
246+
class Inflate extends stream.Transform {
247+
constructor(options?: ZlibOptions);
248+
}
209249
interface Inflate extends stream.Transform, Zlib, ZlibReset {}
250+
/**
251+
* @since v0.5.8
252+
*/
253+
class DeflateRaw extends stream.Transform {
254+
constructor(options?: ZlibOptions);
255+
}
210256
interface DeflateRaw extends stream.Transform, Zlib, ZlibReset, ZlibParams {}
257+
/**
258+
* @since v0.5.8
259+
*/
260+
class InflateRaw extends stream.Transform {
261+
constructor(options?: ZlibOptions);
262+
}
211263
interface InflateRaw extends stream.Transform, Zlib, ZlibReset {}
264+
/**
265+
* @since v0.5.8
266+
*/
267+
class Unzip extends stream.Transform {
268+
constructor(options?: ZlibOptions);
269+
}
212270
interface Unzip extends stream.Transform, Zlib {}
213271
/**
214272
* @since v22.15.0
215273
* @experimental
216274
*/
275+
class ZstdCompress extends stream.Transform {
276+
constructor(options?: ZstdOptions);
277+
}
217278
interface ZstdCompress extends stream.Transform, Zlib {}
218279
/**
219280
* @since v22.15.0
220281
* @experimental
221282
*/
283+
class ZstdDecompress extends stream.Transform {
284+
constructor(options?: ZstdOptions);
285+
}
222286
interface ZstdDecompress extends stream.Transform, Zlib {}
223287
/**
224288
* Computes a 32-bit [Cyclic Redundancy Check](https://en.wikipedia.org/wiki/Cyclic_redundancy_check) checksum of `data`.

0 commit comments

Comments
 (0)