Skip to content

Commit d95a22c

Browse files
rubysrvagg
authored andcommitted
doc: declare all parameter types
PR-URL: #21782 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]>
1 parent 58a9ae1 commit d95a22c

File tree

2 files changed

+23
-21
lines changed

2 files changed

+23
-21
lines changed

doc/api/crypto.md

+2
Original file line numberDiff line numberDiff line change
@@ -2163,6 +2163,7 @@ changes:
21632163
* `keylen` {number}
21642164
* `options` {Object}
21652165
- `cost` {number} CPU/memory cost parameter. Must be a power of two greater
2166+
- `N` {number} CPU/memory cost parameter. Must be a power of two greater
21662167
than one. **Default:** `16384`.
21672168
- `blockSize` {number} Block size parameter. **Default:** `8`.
21682169
- `parallelization` {number} Parallelization parameter. **Default:** `1`.
@@ -2217,6 +2218,7 @@ changes:
22172218
* `keylen` {number}
22182219
* `options` {Object}
22192220
- `cost` {number} CPU/memory cost parameter. Must be a power of two greater
2221+
- `N` {number} CPU/memory cost parameter. Must be a power of two greater
22202222
than one. **Default:** `16384`.
22212223
- `blockSize` {number} Block size parameter. **Default:** `8`.
22222224
- `parallelization` {number} Parallelization parameter. **Default:** `1`.

doc/api/zlib.md

+21-21
Original file line numberDiff line numberDiff line change
@@ -480,7 +480,7 @@ Provides an object enumerating Zlib-related constants.
480480
added: v0.5.8
481481
-->
482482

483-
* `options` {zlib options}
483+
* `options` {Object}
484484

485485
Creates and returns a new [`Deflate`][] object.
486486

@@ -489,7 +489,7 @@ Creates and returns a new [`Deflate`][] object.
489489
added: v0.5.8
490490
-->
491491

492-
* `options` {zlib options}
492+
* `options` {Object}
493493

494494
Creates and returns a new [`DeflateRaw`][] object.
495495

@@ -505,7 +505,7 @@ that effectively uses an 8-bit window only.
505505
added: v0.5.8
506506
-->
507507

508-
* `options` {zlib options}
508+
* `options` {Object}
509509

510510
Creates and returns a new [`Gunzip`][] object.
511511

@@ -514,7 +514,7 @@ Creates and returns a new [`Gunzip`][] object.
514514
added: v0.5.8
515515
-->
516516

517-
* `options` {zlib options}
517+
* `options` {Object}
518518

519519
Creates and returns a new [`Gzip`][] object.
520520

@@ -523,7 +523,7 @@ Creates and returns a new [`Gzip`][] object.
523523
added: v0.5.8
524524
-->
525525

526-
* `options` {zlib options}
526+
* `options` {Object}
527527

528528
Creates and returns a new [`Inflate`][] object.
529529

@@ -532,7 +532,7 @@ Creates and returns a new [`Inflate`][] object.
532532
added: v0.5.8
533533
-->
534534

535-
* `options` {zlib options}
535+
* `options` {Object}
536536

537537
Creates and returns a new [`InflateRaw`][] object.
538538

@@ -541,7 +541,7 @@ Creates and returns a new [`InflateRaw`][] object.
541541
added: v0.5.8
542542
-->
543543

544-
* `options` {zlib options}
544+
* `options` {Object}
545545

546546
Creates and returns a new [`Unzip`][] object.
547547

@@ -572,7 +572,7 @@ changes:
572572
description: The `buffer` parameter can be an `Uint8Array` now.
573573
-->
574574
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
575-
* `options` {zlib options}
575+
* `options` {Object}
576576
* `callback` {Function}
577577

578578
### zlib.deflateSync(buffer[, options])
@@ -591,7 +591,7 @@ changes:
591591
-->
592592

593593
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
594-
* `options` {zlib options}
594+
* `options` {Object}
595595

596596
Compress a chunk of data with [`Deflate`][].
597597

@@ -608,7 +608,7 @@ changes:
608608
-->
609609

610610
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
611-
* `options` {zlib options}
611+
* `options` {Object}
612612
* `callback` {Function}
613613

614614
### zlib.deflateRawSync(buffer[, options])
@@ -627,7 +627,7 @@ changes:
627627
-->
628628

629629
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
630-
* `options` {zlib options}
630+
* `options` {Object}
631631

632632
Compress a chunk of data with [`DeflateRaw`][].
633633

@@ -647,7 +647,7 @@ changes:
647647
-->
648648

649649
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
650-
* `options` {zlib options}
650+
* `options` {Object}
651651
* `callback` {Function}
652652

653653
### zlib.gunzipSync(buffer[, options])
@@ -666,7 +666,7 @@ changes:
666666
-->
667667

668668
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
669-
* `options` {zlib options}
669+
* `options` {Object}
670670

671671
Decompress a chunk of data with [`Gunzip`][].
672672

@@ -686,7 +686,7 @@ changes:
686686
-->
687687

688688
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
689-
* `options` {zlib options}
689+
* `options` {Object}
690690
* `callback` {Function}
691691

692692
### zlib.gzipSync(buffer[, options])
@@ -705,7 +705,7 @@ changes:
705705
-->
706706

707707
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
708-
* `options` {zlib options}
708+
* `options` {Object}
709709

710710
Compress a chunk of data with [`Gzip`][].
711711

@@ -725,7 +725,7 @@ changes:
725725
-->
726726

727727
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
728-
* `options` {zlib options}
728+
* `options` {Object}
729729
* `callback` {Function}
730730

731731
### zlib.inflateSync(buffer[, options])
@@ -744,7 +744,7 @@ changes:
744744
-->
745745

746746
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
747-
* `options` {zlib options}
747+
* `options` {Object}
748748

749749
Decompress a chunk of data with [`Inflate`][].
750750

@@ -764,7 +764,7 @@ changes:
764764
-->
765765

766766
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
767-
* `options` {zlib options}
767+
* `options` {Object}
768768
* `callback` {Function}
769769

770770
### zlib.inflateRawSync(buffer[, options])
@@ -783,7 +783,7 @@ changes:
783783
-->
784784

785785
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
786-
* `options` {zlib options}
786+
* `options` {Object}
787787

788788
Decompress a chunk of data with [`InflateRaw`][].
789789

@@ -803,7 +803,7 @@ changes:
803803
-->
804804

805805
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
806-
* `options` {zlib options}
806+
* `options` {Object}
807807
* `callback` {Function}
808808

809809
### zlib.unzipSync(buffer[, options])
@@ -822,7 +822,7 @@ changes:
822822
-->
823823

824824
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
825-
* `options` {zlib options}
825+
* `options` {Object}
826826

827827
Decompress a chunk of data with [`Unzip`][].
828828

0 commit comments

Comments
 (0)