Better JSDoc
This commit is contained in:
parent
c99d649646
commit
f48ae77485
|
@ -106,7 +106,9 @@ iterations of Miller-Rabin Probabilistic Primality Test (FIPS 186-4 C.3.1)</p>
|
||||||
<dt><a href="#prime">prime(bitLength, iterations)</a> ⇒ <code>Promise</code></dt>
|
<dt><a href="#prime">prime(bitLength, iterations)</a> ⇒ <code>Promise</code></dt>
|
||||||
<dd><p>A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator.
|
<dd><p>A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator.
|
||||||
The browser version uses web workers to parallelise prime look up. Therefore, it does not lock the UI
|
The browser version uses web workers to parallelise prime look up. Therefore, it does not lock the UI
|
||||||
main process, and it can be much faster (if several cores or cpu are available).</p>
|
main process, and it can be much faster (if several cores or cpu are available).
|
||||||
|
The node version can also use worker_threads if they are available (enabled by default with Node 11 and
|
||||||
|
and can be enabled at runtime executing node --experimental-worker with node >=10.5.0)</p>
|
||||||
</dd>
|
</dd>
|
||||||
<dt><a href="#randBetween">randBetween(max, min)</a> ⇒ <code>Promise</code></dt>
|
<dt><a href="#randBetween">randBetween(max, min)</a> ⇒ <code>Promise</code></dt>
|
||||||
<dd><p>Returns a cryptographically secure random integer between [min,max]</p>
|
<dd><p>Returns a cryptographically secure random integer between [min,max]</p>
|
||||||
|
@ -227,7 +229,9 @@ Modular exponentiation a**b mod n
|
||||||
## prime(bitLength, iterations) ⇒ <code>Promise</code>
|
## prime(bitLength, iterations) ⇒ <code>Promise</code>
|
||||||
A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator.
|
A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator.
|
||||||
The browser version uses web workers to parallelise prime look up. Therefore, it does not lock the UI
|
The browser version uses web workers to parallelise prime look up. Therefore, it does not lock the UI
|
||||||
main process, and it can be much faster (if several cores or cpu are available).
|
main process, and it can be much faster (if several cores or cpu are available).
|
||||||
|
The node version can also use worker_threads if they are available (enabled by default with Node 11 and
|
||||||
|
and can be enabled at runtime executing node --experimental-worker with node >=10.5.0)
|
||||||
|
|
||||||
**Kind**: global function
|
**Kind**: global function
|
||||||
**Returns**: <code>Promise</code> - A promise that resolves to a bigint probable prime of bitLength bits
|
**Returns**: <code>Promise</code> - A promise that resolves to a bigint probable prime of bitLength bits
|
||||||
|
|
|
@ -184,6 +184,8 @@ var bigintCryptoUtils = (function (exports) {
|
||||||
* A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator.
|
* A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator.
|
||||||
* The browser version uses web workers to parallelise prime look up. Therefore, it does not lock the UI
|
* The browser version uses web workers to parallelise prime look up. Therefore, it does not lock the UI
|
||||||
* main process, and it can be much faster (if several cores or cpu are available).
|
* main process, and it can be much faster (if several cores or cpu are available).
|
||||||
|
* The node version can also use worker_threads if they are available (enabled by default with Node 11 and
|
||||||
|
* and can be enabled at runtime executing node --experimental-worker with node >=10.5.0)
|
||||||
*
|
*
|
||||||
* @param {number} bitLength The required bit length for the generated prime
|
* @param {number} bitLength The required bit length for the generated prime
|
||||||
* @param {number} iterations The number of iterations for the Miller-Rabin Probabilistic Primality Test
|
* @param {number} iterations The number of iterations for the Miller-Rabin Probabilistic Primality Test
|
||||||
|
|
|
@ -181,6 +181,8 @@ function modPow(a, b, n) {
|
||||||
* A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator.
|
* A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator.
|
||||||
* The browser version uses web workers to parallelise prime look up. Therefore, it does not lock the UI
|
* The browser version uses web workers to parallelise prime look up. Therefore, it does not lock the UI
|
||||||
* main process, and it can be much faster (if several cores or cpu are available).
|
* main process, and it can be much faster (if several cores or cpu are available).
|
||||||
|
* The node version can also use worker_threads if they are available (enabled by default with Node 11 and
|
||||||
|
* and can be enabled at runtime executing node --experimental-worker with node >=10.5.0)
|
||||||
*
|
*
|
||||||
* @param {number} bitLength The required bit length for the generated prime
|
* @param {number} bitLength The required bit length for the generated prime
|
||||||
* @param {number} iterations The number of iterations for the Miller-Rabin Probabilistic Primality Test
|
* @param {number} iterations The number of iterations for the Miller-Rabin Probabilistic Primality Test
|
||||||
|
|
|
@ -189,6 +189,8 @@ function modPow(a, b, n) {
|
||||||
* A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator.
|
* A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator.
|
||||||
* The browser version uses web workers to parallelise prime look up. Therefore, it does not lock the UI
|
* The browser version uses web workers to parallelise prime look up. Therefore, it does not lock the UI
|
||||||
* main process, and it can be much faster (if several cores or cpu are available).
|
* main process, and it can be much faster (if several cores or cpu are available).
|
||||||
|
* The node version can also use worker_threads if they are available (enabled by default with Node 11 and
|
||||||
|
* and can be enabled at runtime executing node --experimental-worker with node >=10.5.0)
|
||||||
*
|
*
|
||||||
* @param {number} bitLength The required bit length for the generated prime
|
* @param {number} bitLength The required bit length for the generated prime
|
||||||
* @param {number} iterations The number of iterations for the Miller-Rabin Probabilistic Primality Test
|
* @param {number} iterations The number of iterations for the Miller-Rabin Probabilistic Primality Test
|
||||||
|
|
|
@ -206,6 +206,8 @@ export function modPow(a, b, n) {
|
||||||
* A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator.
|
* A probably-prime (Miller-Rabin), cryptographically-secure, random-number generator.
|
||||||
* The browser version uses web workers to parallelise prime look up. Therefore, it does not lock the UI
|
* The browser version uses web workers to parallelise prime look up. Therefore, it does not lock the UI
|
||||||
* main process, and it can be much faster (if several cores or cpu are available).
|
* main process, and it can be much faster (if several cores or cpu are available).
|
||||||
|
* The node version can also use worker_threads if they are available (enabled by default with Node 11 and
|
||||||
|
* and can be enabled at runtime executing node --experimental-worker with node >=10.5.0)
|
||||||
*
|
*
|
||||||
* @param {number} bitLength The required bit length for the generated prime
|
* @param {number} bitLength The required bit length for the generated prime
|
||||||
* @param {number} iterations The number of iterations for the Miller-Rabin Probabilistic Primality Test
|
* @param {number} iterations The number of iterations for the Miller-Rabin Probabilistic Primality Test
|
||||||
|
|
Loading…
Reference in New Issue