Generates secure random numbers using crypto.randomBytes()
. Numbers can be of any magnitude and in any base from 2 to 64.
This package is a full rework of my old package csprng-64
but now far better. I decided to release it as a completely separate package and deprecate the previous one as the entire code base was changed and I wasn't fond of the previous name either.
Install
Install with yarn:
$ yarn add awesome-crypto
Usage
Call the function passing the number of required bits, and the radix of the
output.
const { crypto } = require('awesome-crypto');
crypto(160, 64);
const { Radix } = require('awesome-crypto');
crypto(160, Radix.base64);
Documentation
Constants
- DEFAULT_BITS :
number
- DEFAULT_RADIX :
number
Functions
- crypto([bits], [radix]) ⇒
string
Generates a cryptographic string given an amount of bits and a base radix
Radix : enum
Possible options to use as the radix
Kind: global enum
Properties
Name | Type |
---|
16 | Radix.base16 |
32 | Radix.base32 |
58 | Radix.base58 |
64 | Radix.base64 |
DEFAULT_BITS : number
Kind: global constant
DEFAULT_RADIX : number
Kind: global constant
crypto([bits], [radix]) ⇒ string
Generates a cryptographic string given an amount of bits and a base radix
Kind: global function
Returns: string
- The cryptographic string
Param | Type | Default | Description |
---|
[bits] | number | DEFAULT_BITS | The amount of bits to generate |
[radix] | Radix | DEFAULT_RADIX | The radix to generate for |
About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
License
Copyright © 2019, Favna.
Released under the MIT License.
Buy me a donut
This project is open source and always will be, even if I don't get donations. That said, I know there are people out there that may still want to donate just to show their appreciation so this is for you guys. Thanks in advance!
I accept donations through PayPal, BitCoin, Ethereum and LiteCoin. You can use the buttons below to donate through your method of choice