crypto: add better scrypt option aliases

addaleax · rvagg · commit 58580e9ec270 · 2018-08-13T17:43:52.000+10:00
Make parameter names available in a human-readable way, for more accessible/self-documenting usage of the `scrypt` functions. This implements a review comment from the original PR that has not been addressed. Refs: #20816 (comment) PR-URL: #21525 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
diff --git a/doc/api/crypto.md b/doc/api/crypto.md
@@ -2163,7 +2163,6 @@ 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`.
@@ -2218,7 +2217,6 @@ 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`.
