Cleanup examples

dingosky · dingosky · commit 6d31aa81dae5 · 2017-08-31T20:39:15.000-07:00
diff --git a/examples/charSets.js b/examples/charSets.js
@@ -1,3 +1,5 @@
+// Predefined character sets
+
 import {charSet64, charSet32, charSet16, charSet8, charSet4, charSet2} from './entropy-string'
 
 console.log('\n  charSet64: ' + charSet64.chars())
diff --git a/examples/custom_bytes.js b/examples/custom_bytes.js
@@ -1,14 +1,16 @@
+// Custom bytes
+
 import {Random} from './entropy-string'
 
-let random = new Random()
-let bytes = Buffer.from([250, 200, 150, 100])
+const random = new Random()
+const bytes = Buffer.from([250, 200, 150, 100])
 let string = random.stringWithBytes(30, bytes)
 console.log('\n  Custom bytes string : ' + string + '\n')
 
 try {
   string = random.stringWithBytes(32, bytes)
 }
 catch(error) {
-  console.log('  Error: ' + error.message)
+  console.log('  Error: ' + error.message + '\n')
 }
 
diff --git a/examples/custom_chars_1.js b/examples/custom_chars_1.js
@@ -1,10 +1,11 @@
+// Custom characters: HT for coin flip
+
 import {Random, charSet2} from './entropy-string'
 
-let random = new Random(charSet2)
+const random = new Random(charSet2)
 let flips = random.string(10)
-console.log('\n  10 flips: ' + flips + '\n')
+console.log('\n  10 flips: ' + flips)
 
 random.useChars('HT')
 flips = random.string(10)
 console.log('\n  10 flips: ' + flips + '\n')
-
diff --git a/examples/custom_chars_2.js b/examples/custom_chars_2.js
@@ -1,5 +1,7 @@
+// Custom characters: Uppercase hex
+
 import {Random} from './entropy-string'
 
-let random = new Random('0123456789ABCDEF')
-let string = random.string(48)
+const random = new Random('0123456789ABCDEF')
+const string = random.string(48)
 console.log('\n  Uppercase hex: ' + string + '\n')
diff --git a/examples/custom_chars_3.js b/examples/custom_chars_3.js
@@ -1,16 +1,17 @@
+// Custom character errors
+
 import {Random} from './entropy-string'
 
 try {
-  let random = new Random('123456')
+  const random = new Random('123456')
 }
 catch(error) {
-  console.log('Error: ' + error.message)
+  console.log('\n  Error: ' + error.message)
 }
 
-
 try {
-  let random = new Random('01233210')
+  const random = new Random('01233210')
 }
 catch(error) {
-  console.log('Error: ' + error.message)
+  console.log('\n  Error: ' + error.message + '\n')
 }
diff --git a/examples/gen5.js b/examples/gen5.js
@@ -1,10 +1,10 @@
 import {Random, Entropy, charSet16} from './entropy-string'
 
-let random = new Random(charSet16)
-let bits = Entropy.bits(10000, 1000000)
-let strings = Array()
+const random = new Random(charSet16)
+const bits = Entropy.bits(10000, 1000000)
+const strings = Array()
 for (let i = 0; i < 5; i++) {
-  let string = random.string(bits)
+  const string = random.string(bits)
   strings.push(string)
 }
 console.log('\n  5 IDs: ' + strings.join(', ') + '\n')
diff --git a/examples/more_1.js b/examples/more_1.js
@@ -1,7 +1,10 @@
+// Ten thousand potential strings with 1 in a million risk of repeat
+
 import {Random, Entropy} from './entropy-string'
 
-let random = new Random()
-let bits = Entropy.bits(10000, 1000000)
-let string = random.string(bits)
-console.log('\n  Base 32 string : ' + string + '\n')
+const random = new Random()
+const bits = Entropy.bits(10000, 1000000)
+const string = random.string(bits)
+
+console.log('\n  Ten thousand potential strings with 1 in a million risk of repeat: ' + string + '\n')
 
diff --git a/examples/more_2.js b/examples/more_2.js
@@ -1,7 +1,9 @@
+// Base 16 (hex) and base 4
+
 import {Random, Entropy, charSet16, charSet4} from './entropy-string'
 
-let random = new Random(charSet16)
-let bits = Entropy.bits(30, 100000)
+const random = new Random(charSet16)
+const bits = Entropy.bits(30, 100000)
 let string = random.string(bits)
 console.log('\n  Base 16 string : ' + string)
 
diff --git a/examples/more_3.js b/examples/more_3.js
@@ -1,6 +1,9 @@
+// Ten billion potential strings with 1 in a trillion risk of repeat
+
 import {Random, Entropy} from './entropy-string'
 
-let random = new Random()
-let bits = Entropy.bitsWithPowers(10, 12)
-let string = random.string(bits)
-console.log('\n  Base 32 string : ' + string + '\n')
+const random = new Random()
+const bits = Entropy.bitsWithPowers(10, 12)
+const string = random.string(bits)
+
+console.log('\n  Ten billion potential strings with 1 in a trillion risk of repeat: ' + string + '\n')
diff --git a/examples/more_4.js b/examples/more_4.js
diff --git a/examples/more_5.js b/examples/more_5.js
diff --git a/examples/secure.js b/examples/secure.js
@@ -1,6 +1,8 @@
+// Cryptographically strong and not...
+
 import {Random} from './entropy-string'
 
-let random = new Random()
+const random = new Random()
 let string = random.string(80)
 console.log('\n  CSPRNG base 32 80-bit string : ' + string)
 
diff --git a/examples/tldr.js b/examples/tldr.js
diff --git a/examples/tldr2.js b/examples/tldr2.js
@@ -1,6 +1,9 @@
+// Base32 string with a 1 in a billion chance of repeat in a million strings
+
 import {Random, Entropy} from './entropy-string'
   
-let random = new Random()
-let bits = Entropy.bitsWithPowers(6,9)
-let string = random.string(bits)
+const random = new Random()
+const bits = Entropy.bitsWithPowers(6,9)
+const string = random.string(bits)
+
 console.log('\n  Base32 string with a 1 in a billion chance of repeat in a million strings: ' + string + '\n')
diff --git a/examples/tldr_1.js b/examples/tldr_1.js
@@ -1,5 +1,10 @@
-import {Random} from './entropy-string'
-  
-let random = new Random()
-let string = random.sessionID()
-console.log('\n  OWASP session ID using base32 characters: ' + string + '\n')
+// Potential of _1 million_ random strings with _1 in a billion_ chance of repeat
+
+import {Random, Entropy} from './entropy-string'
+
+const random = new Random()
+const bits = Entropy.bitsWithPowers(6, 9)
+
+const string = random.string(bits)
+
+console.log('\n  Potential 1 million random strings with 1 in a billion chance of repeat: ' + string  + '\n')
diff --git a/examples/tldr_2.js b/examples/tldr_2.js
@@ -1,5 +1,11 @@
-import {Random, charSet64} from './entropy-string'
+// Generate a potential of _1 million_ random strings with _1 in a billion_ chance of repeat using
+// hexadecimal strings.
+
+import {Random, Entropy, charSet16} from './entropy-string'
   
-let random = new Random()
-let string = random.sessionID(charSet64)
-console.log('\n  OWASP session ID using RFC 4648 file system and URL safe characters: ' + string + '\n')
+const random = new Random(charSet16)
+const bits = Entropy.bitsWithPowers(6, 9)
+
+const string = random.string(bits)
+
+console.log('\n  Potential 1 million random strings with 1 in a billion chance of repeat: ' + string  + '\n')
diff --git a/examples/tldr_3.js b/examples/tldr_3.js
@@ -1,5 +1,10 @@
-import {Random, charSet16} from './entropy-string'
+// Custom uppercase hexadecimal characters
+
+import {Random, Entropy} from './entropy-string'
   
-let random = new Random(charSet16)
-let string = random.string(48)
-console.log('\n  48-bit string using hex characters: ' + string  + '\n')
+const random = new Random('0123456789ABCDEF')
+const bits = Entropy.bitsWithPowers(6, 9)
+
+const string = random.string(bits)
+
+console.log('\n  Custom uppercase hexadecimal characters: ' + string + '\n')
diff --git a/examples/tldr_4.js b/examples/tldr_4.js
@@ -1,5 +1,8 @@
+// Small ID with 1 in a million chance of repeat for 30 strings
+
 import {Random} from './entropy-string'
   
-let random = new Random('0123456789ABCDEF')
-let string = random.string(48)
-console.log('\n  48-bit string using hex characters: ' + string + '\n')
+const random = new Random()
+const string = random.smallID()
+
+console.log('\n  Small ID with 1 in a million chance of repeat for 30 strings: ' + string + '\n')
diff --git a/examples/tldr_5.js b/examples/tldr_5.js
@@ -1,6 +1,8 @@
-import {Random, Entropy} from './entropy-string'
+// OWASP session ID using base32 characters
+
+import {Random} from './entropy-string'
   
-let random = new Random()
-let bits = Entropy.bits(30, 1000000)
-let string = random.string(bits)
-console.log('\n  Base 32 character string with a 1 in a million chance of a repeat in 30 strings: ' + string + '\n')
+const random = new Random()
+const string = random.sessionID()
+
+console.log('\n  OWASP session ID using base32 characters: ' + string + '\n')
diff --git a/examples/tldr_6.js b/examples/tldr_6.js
@@ -1,6 +1,8 @@
-import {Random, Entropy, charSet64} from './entropy-string'
+// OWASP session ID using RFC 4648 file system and URL safe characters
 
-let random = new Random(charSet64)
-let bits = Entropy.bitsWithPowers(7, 12)
-let string = random.string(bits)
-console.log('\n  Base 64 character string with a 1 in a trillion chance of a repeat in 100 million strings: ' + string + '\n')
+import {Random, charSet64} from './entropy-string'
+  
+const random = new Random(charSet64)
+const string = random.sessionID()
+
+console.log('\n  OWASP session ID using RFC 4648 file system and URL safe characters: ' + string + '\n')
diff --git a/examples/tldr_7.js b/examples/tldr_7.js
@@ -0,0 +1,9 @@
+// Base 64 character 256 bit token
+
+import {Random, Entropy, charSet64} from './entropy-string'
+
+const random = new Random(charSet64)
+
+const string = random.token()
+
+console.log('\n  Base 64 character 256 bit token: ' + string + '\n')

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+// Predefined character sets`
	`2`	`+`
`1`	`3`	`import {charSet64, charSet32, charSet16, charSet8, charSet4, charSet2} from './entropy-string'`
`2`	`4`
`3`	`5`	`console.log('\n charSet64: ' + charSet64.chars())`
Original file line number	Diff line number	Diff line change
`@@ -1,16 +1,17 @@`
	`1`	`+// Custom character errors`
	`2`	`+`
`1`	`3`	`import {Random} from './entropy-string'`
`2`	`4`
`3`	`5`	`try {`
`4`		`- let random = new Random('123456')`
	`6`	`+ const random = new Random('123456')`
`5`	`7`	`}`
`6`	`8`	`catch(error) {`
`7`		`- console.log('Error: ' + error.message)`
	`9`	`+ console.log('\n Error: ' + error.message)`
`8`	`10`	`}`
`9`	`11`
`10`		`-`
`11`	`12`	`try {`
`12`		`- let random = new Random('01233210')`
	`13`	`+ const random = new Random('01233210')`
`13`	`14`	`}`
`14`	`15`	`catch(error) {`
`15`		`- console.log('Error: ' + error.message)`
	`16`	`+ console.log('\n Error: ' + error.message + '\n')`
`16`	`17`	`}`