crypto-random-string

Generate a cryptographically strong random string

Can be useful for creating an identifier, slug, salt, PIN code, fixture, etc.

Works in Node.js and browsers.

Install

1npm install crypto-random-string

Usage

1import cryptoRandomString from 'crypto-random-string';
2
3cryptoRandomString({length: 10});
4//=> '2cf05d94db'
5
6cryptoRandomString({length: 10, type: 'base64'});
7//=> 'YMiMbaQl6I'
8
9cryptoRandomString({length: 10, type: 'url-safe'});
10//=> 'YN-tqc8pOw'
11
12cryptoRandomString({length: 10, type: 'numeric'});
13//=> '8314659141'
14
15cryptoRandomString({length: 6, type: 'distinguishable'});
16//=> 'CDEHKM'
17
18cryptoRandomString({length: 10, type: 'ascii-printable'});
19//=> '`#Rt8$IK>B'
20
21cryptoRandomString({length: 10, type: 'alphanumeric'});
22//=> 'DMuKL8YtE7'
23
24cryptoRandomString({length: 10, characters: 'abc'});
25//=> 'abaaccabac'

API

cryptoRandomString(options)

Returns a randomized string. Hex by default.

cryptoRandomStringAsync(options)

Returns a promise which resolves to a randomized string. Hex by default.

For most use-cases, there's really no good reason to use this async version. From the Node.js docs:

The crypto.randomBytes() method will not complete until there is sufficient entropy available. This should normally never take longer than a few milliseconds. The only time when generating the random bytes may conceivably block for a longer period of time is right after boot, when the whole system is still low on entropy.

In general, anything async comes with some overhead on it's own.

1import {cryptoRandomStringAsync} from 'crypto-random-string';
2
3await cryptoRandomStringAsync({length: 10});
4//=> '2cf05d94db'

options

Type: object

length

Required
Type: number

Length of the returned string.

type

Type: string
Default: 'hex'
Values: 'hex' | 'base64' | 'url-safe' | 'numeric' | 'distinguishable' | 'ascii-printable' | 'alphanumeric'

Use only characters from a predefined set of allowed characters.

Cannot be set at the same time as the characters option.

The distinguishable set contains only uppercase characters that are not easily confused: CDEHKMPRTUWXY012458. It can be useful if you need to print out a short string that you'd like users to read and type back in with minimal errors. For example, reading a code off of a screen that needs to be typed into a phone to connect two devices.

The ascii-printable set contains all printable ASCII characters: !"#$%&\'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~ Useful for generating passwords where all possible ASCII characters should be used.

The alphanumeric set contains uppercase letters, lowercase letters, and digits: ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789. Useful for generating nonce values.

characters

Type: string
Minimum length: 1
Maximum length: 65536

Use only characters from a custom set of allowed characters.

Cannot be set at the same time as the type option.

Related

• random-int - Generate a random integer
• random-float - Generate a random float
• random-item - Get a random item from an array
• random-boolean - Get a random boolean
• random-obj-key - Get a random key from an object
• random-obj-prop - Get a random property from an object
• unique-random - Generate random numbers that are consecutively unique

---