Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit a53253a

Browse filesBrowse files
addaleaxMyles Borins
authored andcommitted
doc: add added: information for zlib
Ref: #6578 PR-URL: #6840 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
1 parent 7abfb6e commit a53253a
Copy full SHA for a53253a

File tree

Expand file treeCollapse file tree

1 file changed

+102
-0
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+102
-0
lines changed
Open diff view settings
Collapse file

‎doc/api/zlib.md‎

Copy file name to clipboardExpand all lines: doc/api/zlib.md
+102Lines changed: 102 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,9 @@ http.createServer((request, response) => {
186186
```
187187

188188
## Constants
189+
<!-- YAML
190+
added: v0.5.8
191+
-->
189192

190193
<!--type=misc-->
191194

@@ -252,6 +255,9 @@ For initializing zalloc, zfree, opaque.
252255
* `zlib.Z_NULL`
253256

254257
## Class Options
258+
<!-- YAML
259+
added: v0.11.1
260+
-->
255261

256262
<!--type=misc-->
257263

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

274280
## Class: zlib.Deflate
281+
<!-- YAML
282+
added: v0.5.8
283+
-->
275284

276285
Compress data using deflate.
277286

278287
## Class: zlib.DeflateRaw
288+
<!-- YAML
289+
added: v0.5.8
290+
-->
279291

280292
Compress data using deflate, and do not append a zlib header.
281293

282294
## Class: zlib.Gunzip
295+
<!-- YAML
296+
added: v0.5.8
297+
-->
283298

284299
Decompress a gzip stream.
285300

286301
## Class: zlib.Gzip
302+
<!-- YAML
303+
added: v0.5.8
304+
-->
287305

288306
Compress data using gzip.
289307

290308
## Class: zlib.Inflate
309+
<!-- YAML
310+
added: v0.5.8
311+
-->
291312

292313
Decompress a deflate stream.
293314

294315
## Class: zlib.InflateRaw
316+
<!-- YAML
317+
added: v0.5.8
318+
-->
295319

296320
Decompress a raw deflate stream.
297321

298322
## Class: zlib.Unzip
323+
<!-- YAML
324+
added: v0.5.8
325+
-->
299326

300327
Decompress either a Gzip- or Deflate-compressed stream by auto-detecting
301328
the header.
302329

303330
## Class: zlib.Zlib
331+
<!-- YAML
332+
added: v0.5.8
333+
-->
304334

305335
Not exported by the `zlib` module. It is documented here because it is the base
306336
class of the compressor/decompressor classes.
307337

308338
### zlib.flush([kind], callback)
339+
<!-- YAML
340+
added: v0.5.8
341+
-->
309342

310343
`kind` defaults to `zlib.Z_FULL_FLUSH`.
311344

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

320353
### zlib.params(level, strategy, callback)
354+
<!-- YAML
355+
added: v0.11.4
356+
-->
321357

322358
Dynamically update the compression level and compression strategy.
323359
Only applicable to deflate algorithm.
324360

325361
### zlib.reset()
362+
<!-- YAML
363+
added: v0.7.0
364+
-->
326365

327366
Reset the compressor/decompressor to factory defaults. Only applicable to
328367
the inflate and deflate algorithms.
329368

330369
## zlib.createDeflate([options])
370+
<!-- YAML
371+
added: v0.5.8
372+
-->
331373

332374
Returns a new [Deflate][] object with an [options][].
333375

334376
## zlib.createDeflateRaw([options])
377+
<!-- YAML
378+
added: v0.5.8
379+
-->
335380

336381
Returns a new [DeflateRaw][] object with an [options][].
337382

338383
## zlib.createGunzip([options])
384+
<!-- YAML
385+
added: v0.5.8
386+
-->
339387

340388
Returns a new [Gunzip][] object with an [options][].
341389

342390
## zlib.createGzip([options])
391+
<!-- YAML
392+
added: v0.5.8
393+
-->
343394

344395
Returns a new [Gzip][] object with an [options][].
345396

346397
## zlib.createInflate([options])
398+
<!-- YAML
399+
added: v0.5.8
400+
-->
347401

348402
Returns a new [Inflate][] object with an [options][].
349403

350404
## zlib.createInflateRaw([options])
405+
<!-- YAML
406+
added: v0.5.8
407+
-->
351408

352409
Returns a new [InflateRaw][] object with an [options][].
353410

354411
## zlib.createUnzip([options])
412+
<!-- YAML
413+
added: v0.5.8
414+
-->
355415

356416
Returns a new [Unzip][] object with an [options][].
357417

@@ -367,37 +427,79 @@ Every method has a `*Sync` counterpart, which accept the same arguments, but
367427
without a callback.
368428

369429
### zlib.deflate(buf[, options], callback)
430+
<!-- YAML
431+
added: v0.6.0
432+
-->
370433
### zlib.deflateSync(buf[, options])
434+
<!-- YAML
435+
added: v0.11.12
436+
-->
371437

372438
Compress a Buffer or string with Deflate.
373439

374440
### zlib.deflateRaw(buf[, options], callback)
441+
<!-- YAML
442+
added: v0.6.0
443+
-->
375444
### zlib.deflateRawSync(buf[, options])
445+
<!-- YAML
446+
added: v0.11.12
447+
-->
376448

377449
Compress a Buffer or string with DeflateRaw.
378450

379451
### zlib.gunzip(buf[, options], callback)
452+
<!-- YAML
453+
added: v0.6.0
454+
-->
380455
### zlib.gunzipSync(buf[, options])
456+
<!-- YAML
457+
added: v0.11.12
458+
-->
381459

382460
Decompress a Buffer or string with Gunzip.
383461

384462
### zlib.gzip(buf[, options], callback)
463+
<!-- YAML
464+
added: v0.6.0
465+
-->
385466
### zlib.gzipSync(buf[, options])
467+
<!-- YAML
468+
added: v0.11.12
469+
-->
386470

387471
Compress a Buffer or string with Gzip.
388472

389473
### zlib.inflate(buf[, options], callback)
474+
<!-- YAML
475+
added: v0.6.0
476+
-->
390477
### zlib.inflateSync(buf[, options])
478+
<!-- YAML
479+
added: v0.11.12
480+
-->
391481

392482
Decompress a Buffer or string with Inflate.
393483

394484
### zlib.inflateRaw(buf[, options], callback)
485+
<!-- YAML
486+
added: v0.6.0
487+
-->
395488
### zlib.inflateRawSync(buf[, options])
489+
<!-- YAML
490+
added: v0.11.12
491+
-->
396492

397493
Decompress a Buffer or string with InflateRaw.
398494

399495
### zlib.unzip(buf[, options], callback)
496+
<!-- YAML
497+
added: v0.6.0
498+
-->
400499
### zlib.unzipSync(buf[, options])
500+
<!-- YAML
501+
added: v0.11.12
502+
-->
401503

402504
Decompress a Buffer or string with Unzip.
403505

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.