Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSam Ruby <rubys@intertwingly.net>2018-07-12 20:48:11 +0300
committerRod Vagg <rod@vagg.org>2018-08-15 13:23:17 +0300
commitd95a22c3041e2ac09aa7ab61c69551e67ebcc588 (patch)
tree2a750c318b0039960bf887ea1c4c78e5e496e70a /doc
parent58a9ae118ec348202f1d4de2809fa8006bc08cde (diff)
doc: declare all parameter types
PR-URL: https://github.com/nodejs/node/pull/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>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/crypto.md2
-rw-r--r--doc/api/zlib.md42
2 files changed, 23 insertions, 21 deletions
diff --git a/doc/api/crypto.md b/doc/api/crypto.md
index 8e76f7c6c49..b2addbe1fb5 100644
--- a/doc/api/crypto.md
+++ b/doc/api/crypto.md
@@ -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`.
@@ -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`.
diff --git a/doc/api/zlib.md b/doc/api/zlib.md
index 746058f5a33..7a850373a82 100644
--- a/doc/api/zlib.md
+++ b/doc/api/zlib.md
@@ -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.
@@ -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.
@@ -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.
@@ -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.
@@ -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.
@@ -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.
@@ -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.
@@ -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])
@@ -591,7 +591,7 @@ changes:
-->
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
-* `options` {zlib options}
+* `options` {Object}
Compress a chunk of data with [`Deflate`][].
@@ -608,7 +608,7 @@ changes:
-->
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
-* `options` {zlib options}
+* `options` {Object}
* `callback` {Function}
### zlib.deflateRawSync(buffer[, options])
@@ -627,7 +627,7 @@ changes:
-->
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
-* `options` {zlib options}
+* `options` {Object}
Compress a chunk of data with [`DeflateRaw`][].
@@ -647,7 +647,7 @@ changes:
-->
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
-* `options` {zlib options}
+* `options` {Object}
* `callback` {Function}
### zlib.gunzipSync(buffer[, options])
@@ -666,7 +666,7 @@ changes:
-->
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
-* `options` {zlib options}
+* `options` {Object}
Decompress a chunk of data with [`Gunzip`][].
@@ -686,7 +686,7 @@ changes:
-->
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
-* `options` {zlib options}
+* `options` {Object}
* `callback` {Function}
### zlib.gzipSync(buffer[, options])
@@ -705,7 +705,7 @@ changes:
-->
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
-* `options` {zlib options}
+* `options` {Object}
Compress a chunk of data with [`Gzip`][].
@@ -725,7 +725,7 @@ changes:
-->
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
-* `options` {zlib options}
+* `options` {Object}
* `callback` {Function}
### zlib.inflateSync(buffer[, options])
@@ -744,7 +744,7 @@ changes:
-->
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
-* `options` {zlib options}
+* `options` {Object}
Decompress a chunk of data with [`Inflate`][].
@@ -764,7 +764,7 @@ changes:
-->
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
-* `options` {zlib options}
+* `options` {Object}
* `callback` {Function}
### zlib.inflateRawSync(buffer[, options])
@@ -783,7 +783,7 @@ changes:
-->
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
-* `options` {zlib options}
+* `options` {Object}
Decompress a chunk of data with [`InflateRaw`][].
@@ -803,7 +803,7 @@ changes:
-->
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
-* `options` {zlib options}
+* `options` {Object}
* `callback` {Function}
### zlib.unzipSync(buffer[, options])
@@ -822,7 +822,7 @@ changes:
-->
* `buffer` {Buffer|TypedArray|DataView|ArrayBuffer|string}
-* `options` {zlib options}
+* `options` {Object}
Decompress a chunk of data with [`Unzip`][].