Skip to content

Commit

Permalink
doc: declare all parameter types
Browse files Browse the repository at this point in the history
PR-URL: #21782
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
  • Loading branch information
rubys authored and rvagg committed Aug 13, 2018
1 parent 82830a8 commit 79b7a58
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 21 deletions.
2 changes: 2 additions & 0 deletions doc/api/crypto.md
Original file line number Diff line number Diff line change
Expand Up @@ -2163,6 +2163,7 @@ changes:
* `keylen` {number}
* `options` {Object}
- `cost` {number} CPU/memory cost parameter. Must be a power of two greater
- `N` {number} CPU/memory cost parameter. Must be a power of two greater
than one. **Default:** `16384`.
- `blockSize` {number} Block size parameter. **Default:** `8`.
- `parallelization` {number} Parallelization parameter. **Default:** `1`.
Expand Down Expand Up @@ -2217,6 +2218,7 @@ changes:
* `keylen` {number}
* `options` {Object}
- `cost` {number} CPU/memory cost parameter. Must be a power of two greater
- `N` {number} CPU/memory cost parameter. Must be a power of two greater
than one. **Default:** `16384`.
- `blockSize` {number} Block size parameter. **Default:** `8`.
- `parallelization` {number} Parallelization parameter. **Default:** `1`.
Expand Down
42 changes: 21 additions & 21 deletions doc/api/zlib.md
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,7 @@ Provides an object enumerating Zlib-related constants.
added: v0.5.8
-->

* `options` {zlib options}
* `options` {Object}

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

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

* `options` {zlib options}
* `options` {Object}

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

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

* `options` {zlib options}
* `options` {Object}

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

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

* `options` {zlib options}
* `options` {Object}

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

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

* `options` {zlib options}
* `options` {Object}

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

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

* `options` {zlib options}
* `options` {Object}

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

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

* `options` {zlib options}
* `options` {Object}

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

Expand Down Expand Up @@ -572,7 +572,7 @@ changes:
description: The `buffer` parameter can be an `Uint8Array` now.
-->
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
* `options` {zlib options}
* `options` {Object}
* `callback` {Function}

### zlib.deflateSync(buffer[, options])
Expand All @@ -591,7 +591,7 @@ changes:
-->

* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
* `options` {zlib options}
* `options` {Object}

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

Expand All @@ -608,7 +608,7 @@ changes:
-->

* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
* `options` {zlib options}
* `options` {Object}
* `callback` {Function}

### zlib.deflateRawSync(buffer[, options])
Expand All @@ -627,7 +627,7 @@ changes:
-->

* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
* `options` {zlib options}
* `options` {Object}

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

Expand All @@ -647,7 +647,7 @@ changes:
-->

* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
* `options` {zlib options}
* `options` {Object}
* `callback` {Function}

### zlib.gunzipSync(buffer[, options])
Expand All @@ -666,7 +666,7 @@ changes:
-->

* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
* `options` {zlib options}
* `options` {Object}

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

Expand All @@ -686,7 +686,7 @@ changes:
-->

* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
* `options` {zlib options}
* `options` {Object}
* `callback` {Function}

### zlib.gzipSync(buffer[, options])
Expand All @@ -705,7 +705,7 @@ changes:
-->

* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
* `options` {zlib options}
* `options` {Object}

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

Expand All @@ -725,7 +725,7 @@ changes:
-->

* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
* `options` {zlib options}
* `options` {Object}
* `callback` {Function}

### zlib.inflateSync(buffer[, options])
Expand All @@ -744,7 +744,7 @@ changes:
-->

* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
* `options` {zlib options}
* `options` {Object}

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

Expand All @@ -764,7 +764,7 @@ changes:
-->

* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
* `options` {zlib options}
* `options` {Object}
* `callback` {Function}

### zlib.inflateRawSync(buffer[, options])
Expand All @@ -783,7 +783,7 @@ changes:
-->

* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
* `options` {zlib options}
* `options` {Object}

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

Expand All @@ -803,7 +803,7 @@ changes:
-->

* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
* `options` {zlib options}
* `options` {Object}
* `callback` {Function}

### zlib.unzipSync(buffer[, options])
Expand All @@ -822,7 +822,7 @@ changes:
-->

* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
* `options` {zlib options}
* `options` {Object}

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

Expand Down

0 comments on commit 79b7a58

Please sign in to comment.