Files
common/packages/util-crypto/docs/random.md
T
Jaco Greeff 03dc89c2b6 Remove exposed Buffer in crypto (#80)
* Use js-sha3 instead of keccak

* Remove exposed toBuffer from util-crypto

* Add definiton for js-sha3

* Remove Buffer from docs

* Cleanup crypto hashing

* Cleanup interface
2018-02-08 16:12:00 +01:00

58 lines
1.2 KiB
Markdown

# random
Returns a sequence of secure random bytes in a variety of formats
- [randomAsHex](#randomashex) Creates a hex string filled with random bytes.
- [randomAsNumber](#randomasnumber) Creates a random number from random bytes.
- [randomAsU8a](#randomasu8a) Creates a Uint8Array filled with random bytes.
## randomAsHex
Creates a hex string filled with random bytes.
```js
randomAsHex (length?: number = 32): string
```
Returns a hex string with the specified (optional) length filled with random bytes.
```js
import { randomAsHex } from '@polkadot/util-crypto';
randomAsHex() // => 0x...
```
## randomAsNumber
Creates a random number from random bytes.
```js
randomAsNumber (): number
```
Returns a random number generated from the secure bytes.
```js
import { randomAsNumber } from '@polkadot/util-crypto';
randomAsNumber() // => <random number>
```
## randomAsU8a
Creates a Uint8Array filled with random bytes.
```js
randomAsU8a (length?: number = 32): Uint8Array
```
Returns a `Uint8Array` with the specified (optional) length filled with random bytes.
```js
import { randomAsU8a } from '@polkadot/util-crypto';
randomAsU8s() // => Uint8Array([...])
```