hmac-rng
HMAC-based random number generator written in JavaScript.
API Reference
- HmacRng
- HmacRng ⏏
- new HmacRng(seed, [algorithm])
- instance
- .nextInt(min, max) ⇒
number
- .nextInts(min, max, amount) ⇒
Array.<number>
- .nextInt(min, max) ⇒
- static
- .getRandomInt(seed, min, max) ⇒
number
- .getRandomInts(seed, min, max, amount) ⇒
Array.<number>
- .shuffleArray(seed, array) ⇒
Array.<Object>
- .getRandomInt(seed, min, max) ⇒
- HmacRng ⏏
HmacRng ⏏
new HmacRng(seed, [algorithm])
Creates a new HMAC-RNG instance.
Param | Type | Default | Description |
---|---|---|---|
seed | string |
Seed used for randomization. | |
[algorithm] | string |
"sha512" |
Cryptographical algorithm to use HMAC with. |
number
hmacRng.nextInt(min, max) ⇒ Gets the next random integer in the current sequence. The maximum range of 'min' and 'max' is 2^28 (268435456).
Kind: instance method of HmacRng
Returns: number
- The generated random integer.
Param | Type | Description |
---|---|---|
min | number |
Inclusive lower bound of the random integer returned. |
max | number |
Inclusive upper bound of the random integer returned. This must be greater than 'min'. |
Array.<number>
hmacRng.nextInts(min, max, amount) ⇒ Gets the next random integers in the current sequence. The maximum range of 'min' and 'max' is 2^28 (268435456).
Kind: instance method of HmacRng
Returns: Array.<number>
- The generated array of random integers.
Param | Type | Description |
---|---|---|
min | number |
Inclusive lower bound of the random integers returned. |
max | number |
Inclusive upper bound of the random integers returned. This must be greater than 'min'. |
amount | number |
Amount of integers to be generated. |
number
HmacRng.getRandomInt(seed, min, max) ⇒ Generates a random integer using the default algorithm. The maximum range of 'min' and 'max' is 2^28 (268435456).
Kind: static method of HmacRng
Returns: number
- The generated random integer.
Since: 1.1.0
Param | Type | Description |
---|---|---|
seed | string |
Seed used for randomization. |
min | number |
Inclusive lower bound of the random integer returned. |
max | number |
Inclusive upper bound of the random integer returned. This must be greater than 'min'. |
Array.<number>
HmacRng.getRandomInts(seed, min, max, amount) ⇒ Generates random integers using the default algorithm. The maximum range of 'min' and 'max' is 2^28 (268435456).
Kind: static method of HmacRng
Returns: Array.<number>
- The generated array of random integers.
Since: 1.1.0
Param | Type | Description |
---|---|---|
seed | string |
Seed used for randomization. |
min | number |
Inclusive lower bound of the random integers returned. |
max | number |
Inclusive upper bound of the random integers returned. This must be greater than 'min'. |
amount | number |
Amount of integers to be generated. |
Array.<Object>
HmacRng.shuffleArray(seed, array) ⇒ Shuffles the given array using the default algorithm.
Kind: static method of HmacRng
Returns: Array.<Object>
- The array which has been shuffled.
Since: 1.1.0
Param | Type | Description |
---|---|---|
seed | string |
Seed used for randomization. |
array | Array.<Object> |
Array to be shuffled. |