Add ascii-printable character set (#26)

Author: Richienb

index.d.ts

@@ -17,6 +17,8 @@ interface TypeOption {
 
 	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](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters): ``!"#$%&\'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~`` Useful for generating passwords where all possible ASCII characters should be used.
+
 	@example
 	```
 	cryptoRandomString({length: 10});
@@ -33,9 +35,12 @@ interface TypeOption {
 
 	cryptoRandomString({length: 6, type: 'distinguishable'});
 	//=> 'CDEHKM'
+
+	cryptoRandomString({length: 10, type: 'ascii-printable'});
+	//=> '`#Rt8$IK>B'
 	```
 	*/
-	type?: 'hex' | 'base64' | 'url-safe' | 'numeric' | 'distinguishable';
+	type?: 'hex' | 'base64' | 'url-safe' | 'numeric' | 'distinguishable' | 'ascii-printable';
 }
 
 interface CharactersOption {

index.js

@@ -7,6 +7,7 @@ const randomBytesAsync = promisify(crypto.randomBytes);
 const urlSafeCharacters = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-._~'.split('');
 const numericCharacters = '0123456789'.split('');
 const distinguishableCharacters = 'CDEHKMPRTUWXY012458'.split('');
+const asciiPrintableCharacters = '!"#$%&\'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~'.split('');
 
 const generateForCustomCharacters = (length, characters) => {
 	// Generating entropy is faster than complex math operations, so we use the simplest way
@@ -75,7 +76,8 @@ const allowedTypes = [
 	'base64',
 	'url-safe',
 	'numeric',
-	'distinguishable'
+	'distinguishable',
+	'ascii-printable'
 ];
 
 const createGenerator = (generateForCustomCharacters, generateRandomBytes) => ({length, type, characters}) => {
@@ -119,6 +121,10 @@ const createGenerator = (generateForCustomCharacters, generateRandomBytes) => ({
 		return generateForCustomCharacters(length, distinguishableCharacters);
 	}
 
+	if (type === 'ascii-printable') {
+		return generateForCustomCharacters(length, asciiPrintableCharacters);
+	}
+
 	if (characters.length === 0) {
 		throw new TypeError('Expected `characters` string length to be greater than or equal to 1');
 	}

readme.md

@@ -30,6 +30,9 @@ cryptoRandomString({length: 10, type: 'numeric'});
 cryptoRandomString({length: 6, type: 'distinguishable'});
 //=> 'CDEHKM'
 
+cryptoRandomString({length: 10, type: 'ascii-printable'});
+//=> '`#Rt8$IK>B'
+
 cryptoRandomString({length: 10, characters: 'abc'});
 //=> 'abaaccabac'
 ```
@@ -59,14 +62,16 @@ Length of the returned string.
 
 Type: `string`\
 Default: `'hex'`\
-Values: `'hex' | 'base64' | 'url-safe' | 'numeric' | 'distinguishable'`
+Values: `'hex' | 'base64' | 'url-safe' | 'numeric' | 'distinguishable' | 'ascii-printable'`
 
 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](https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters): ``!"#$%&\'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~`` Useful for generating passwords where all possible ASCII characters should be used.
+
 ##### characters
 
 Type: `string`\

test.js

@@ -69,6 +69,13 @@ test('distinguishable', t => {
 	t.is(generatedCharacterSetSize({type: 'distinguishable'}, 19), 19);
 });
 
+test('ascii-printable', t => {
+	t.is(cryptoRandomString({length: 0, type: 'ascii-printable'}).length, 0);
+	t.is(cryptoRandomString({length: 10, type: 'ascii-printable'}).length, 10);
+	t.is(cryptoRandomString({length: 100, type: 'ascii-printable'}).length, 100);
+	t.regex(cryptoRandomString({length: 100, type: 'ascii-printable'}), /^[!"#$%&'()*+,-./\d:;<=>?@A-Z[\\\]^_`a-z{|}~]*$/); // Sanity check, probabilistic
+});
+
 test('characters', t => {
 	t.is(cryptoRandomString({length: 0, characters: '1234'}).length, 0);
 	t.is(cryptoRandomString({length: 10, characters: '1234'}).length, 10);