Skip to content

Commit 136c098

Browse files
addaleaxFishrock123
authored andcommitted
doc: add added: information for zlib
Ref: #6578 PR-URL: #6840 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Myles Borins <[email protected]> Reviewed-By: Robert Jefe Lindstaedt <[email protected]>
1 parent 068ee09 commit 136c098

File tree

1 file changed

+102
-0
lines changed

1 file changed

+102
-0
lines changed

doc/api/zlib.md

+102
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,9 @@ http.createServer((request, response) => {
215215
```
216216

217217
## Constants
218+
<!-- YAML
219+
added: v0.5.8
220+
-->
218221

219222
<!--type=misc-->
220223

@@ -279,6 +282,9 @@ For initializing zalloc, zfree, opaque.
279282
* `zlib.Z_NULL`
280283

281284
## Class Options
285+
<!-- YAML
286+
added: v0.11.1
287+
-->
282288

283289
<!--type=misc-->
284290

@@ -300,40 +306,67 @@ See the description of `deflateInit2` and `inflateInit2` at
300306
<http://zlib.net/manual.html#Advanced> for more information on these.
301307

302308
## Class: zlib.Deflate
309+
<!-- YAML
310+
added: v0.5.8
311+
-->
303312

304313
Compress data using deflate.
305314

306315
## Class: zlib.DeflateRaw
316+
<!-- YAML
317+
added: v0.5.8
318+
-->
307319

308320
Compress data using deflate, and do not append a `zlib` header.
309321

310322
## Class: zlib.Gunzip
323+
<!-- YAML
324+
added: v0.5.8
325+
-->
311326

312327
Decompress a gzip stream.
313328

314329
## Class: zlib.Gzip
330+
<!-- YAML
331+
added: v0.5.8
332+
-->
315333

316334
Compress data using gzip.
317335

318336
## Class: zlib.Inflate
337+
<!-- YAML
338+
added: v0.5.8
339+
-->
319340

320341
Decompress a deflate stream.
321342

322343
## Class: zlib.InflateRaw
344+
<!-- YAML
345+
added: v0.5.8
346+
-->
323347

324348
Decompress a raw deflate stream.
325349

326350
## Class: zlib.Unzip
351+
<!-- YAML
352+
added: v0.5.8
353+
-->
327354

328355
Decompress either a Gzip- or Deflate-compressed stream by auto-detecting
329356
the header.
330357

331358
## Class: zlib.Zlib
359+
<!-- YAML
360+
added: v0.5.8
361+
-->
332362

333363
Not exported by the `zlib` module. It is documented here because it is the base
334364
class of the compressor/decompressor classes.
335365

336366
### zlib.flush([kind], callback)
367+
<!-- YAML
368+
added: v0.5.8
369+
-->
337370

338371
`kind` defaults to `zlib.Z_FULL_FLUSH`.
339372

@@ -346,40 +379,67 @@ normal call to `.write()`, i.e. it will be queued up behind other pending
346379
writes and will only produce output when data is being read from the stream.
347380

348381
### zlib.params(level, strategy, callback)
382+
<!-- YAML
383+
added: v0.11.4
384+
-->
349385

350386
Dynamically update the compression level and compression strategy.
351387
Only applicable to deflate algorithm.
352388

353389
### zlib.reset()
390+
<!-- YAML
391+
added: v0.7.0
392+
-->
354393

355394
Reset the compressor/decompressor to factory defaults. Only applicable to
356395
the inflate and deflate algorithms.
357396

358397
## zlib.createDeflate([options])
398+
<!-- YAML
399+
added: v0.5.8
400+
-->
359401

360402
Returns a new [Deflate][] object with an [options][].
361403

362404
## zlib.createDeflateRaw([options])
405+
<!-- YAML
406+
added: v0.5.8
407+
-->
363408

364409
Returns a new [DeflateRaw][] object with an [options][].
365410

366411
## zlib.createGunzip([options])
412+
<!-- YAML
413+
added: v0.5.8
414+
-->
367415

368416
Returns a new [Gunzip][] object with an [options][].
369417

370418
## zlib.createGzip([options])
419+
<!-- YAML
420+
added: v0.5.8
421+
-->
371422

372423
Returns a new [Gzip][] object with an [options][].
373424

374425
## zlib.createInflate([options])
426+
<!-- YAML
427+
added: v0.5.8
428+
-->
375429

376430
Returns a new [Inflate][] object with an [options][].
377431

378432
## zlib.createInflateRaw([options])
433+
<!-- YAML
434+
added: v0.5.8
435+
-->
379436

380437
Returns a new [InflateRaw][] object with an [options][].
381438

382439
## zlib.createUnzip([options])
440+
<!-- YAML
441+
added: v0.5.8
442+
-->
383443

384444
Returns a new [Unzip][] object with an [options][].
385445

@@ -395,37 +455,79 @@ Every method has a `*Sync` counterpart, which accept the same arguments, but
395455
without a callback.
396456

397457
### zlib.deflate(buf[, options], callback)
458+
<!-- YAML
459+
added: v0.6.0
460+
-->
398461
### zlib.deflateSync(buf[, options])
462+
<!-- YAML
463+
added: v0.11.12
464+
-->
399465

400466
Compress a Buffer or string with Deflate.
401467

402468
### zlib.deflateRaw(buf[, options], callback)
469+
<!-- YAML
470+
added: v0.6.0
471+
-->
403472
### zlib.deflateRawSync(buf[, options])
473+
<!-- YAML
474+
added: v0.11.12
475+
-->
404476

405477
Compress a Buffer or string with DeflateRaw.
406478

407479
### zlib.gunzip(buf[, options], callback)
480+
<!-- YAML
481+
added: v0.6.0
482+
-->
408483
### zlib.gunzipSync(buf[, options])
484+
<!-- YAML
485+
added: v0.11.12
486+
-->
409487

410488
Decompress a Buffer or string with Gunzip.
411489

412490
### zlib.gzip(buf[, options], callback)
491+
<!-- YAML
492+
added: v0.6.0
493+
-->
413494
### zlib.gzipSync(buf[, options])
495+
<!-- YAML
496+
added: v0.11.12
497+
-->
414498

415499
Compress a Buffer or string with Gzip.
416500

417501
### zlib.inflate(buf[, options], callback)
502+
<!-- YAML
503+
added: v0.6.0
504+
-->
418505
### zlib.inflateSync(buf[, options])
506+
<!-- YAML
507+
added: v0.11.12
508+
-->
419509

420510
Decompress a Buffer or string with Inflate.
421511

422512
### zlib.inflateRaw(buf[, options], callback)
513+
<!-- YAML
514+
added: v0.6.0
515+
-->
423516
### zlib.inflateRawSync(buf[, options])
517+
<!-- YAML
518+
added: v0.11.12
519+
-->
424520

425521
Decompress a Buffer or string with InflateRaw.
426522

427523
### zlib.unzip(buf[, options], callback)
524+
<!-- YAML
525+
added: v0.6.0
526+
-->
428527
### zlib.unzipSync(buf[, options])
528+
<!-- YAML
529+
added: v0.11.12
530+
-->
429531

430532
Decompress a Buffer or string with Unzip.
431533

0 commit comments

Comments
 (0)