Skip to content

Commit 0ec2d65

Browse files
committed
doc: improve description of zlib.createXYZ
1 parent 76e3b35 commit 0ec2d65

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

doc/api/zlib.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -440,14 +440,14 @@ Provides an object enumerating Zlib-related constants.
440440
added: v0.5.8
441441
-->
442442

443-
Returns a new [Deflate][] object with an [options][].
443+
Creates and returns a new [Deflate][] object with the given [options][].
444444

445445
## zlib.createDeflateRaw([options])
446446
<!-- YAML
447447
added: v0.5.8
448448
-->
449449

450-
Returns a new [DeflateRaw][] object with an [options][].
450+
Creates and returns a new [DeflateRaw][] object with the given [options][].
451451

452452
*Note*: The zlib library rejects requests for 256-byte windows (i.e.,
453453
`{ windowBits: 8 }` in `options`). An `Error` will be thrown when creating
@@ -458,35 +458,35 @@ a [DeflateRaw][] object with this specific value of the `windowBits` option.
458458
added: v0.5.8
459459
-->
460460

461-
Returns a new [Gunzip][] object with an [options][].
461+
Creates and returns a new [Gunzip][] object with the given [options][].
462462

463463
## zlib.createGzip([options])
464464
<!-- YAML
465465
added: v0.5.8
466466
-->
467467

468-
Returns a new [Gzip][] object with an [options][].
468+
Creates and returns a new [Gzip][] object with the given [options][].
469469

470470
## zlib.createInflate([options])
471471
<!-- YAML
472472
added: v0.5.8
473473
-->
474474

475-
Returns a new [Inflate][] object with an [options][].
475+
Creates and returns a new [Inflate][] object with the given [options][].
476476

477477
## zlib.createInflateRaw([options])
478478
<!-- YAML
479479
added: v0.5.8
480480
-->
481481

482-
Returns a new [InflateRaw][] object with an [options][].
482+
Creates and returns a new [InflateRaw][] object with the given [options][].
483483

484484
## zlib.createUnzip([options])
485485
<!-- YAML
486486
added: v0.5.8
487487
-->
488488

489-
Returns a new [Unzip][] object with an [options][].
489+
Creates and returns a new [Unzip][] object with the given [options][].
490490

491491
## Convenience Methods
492492

0 commit comments

Comments
 (0)