Don’t use bitsWith… functions.

dingosky · dingosky · commit f8abaa9d5469 · 2017-09-02T13:39:56.000-07:00
Function to be removed in next major release
diff --git a/README.md b/README.md
@@ -51,7 +51,7 @@ Generate a potential of _1 million_ random strings with _1 in a billion_ chance
   import {Random, Entropy} from 'entropy-string'
   
   const random = new Random()
-  const bits = Entropy.bitsWithPowers(6, 9)
+  const bits = Entropy.bits(1e6, 1e9)
 
   const string = random.string(bits)
   ```
@@ -63,10 +63,10 @@ See [Real Need](#RealNeed) for description of what entropy bits represents.
 `EntropyString` uses predefined `charset32` characters by default (see [Character Sets](#CharacterSets)). To get a random hexadecimal string with the same entropy `bits` as above:
 
   ```js
-  import {Random, Entropy} from 'entropy-string'
+  import {Random, Entropy, charSet16} from 'entropy-string'
   
   const random = new Random(charSet16)
-  const bits = Entropy.bitsWithPowers(6, 9)
+  const bits = Entropy.bits(1e6, 1e9)
   
   const string = random.string(bits)
   ```
@@ -79,7 +79,7 @@ Custom characters may be specified. Using uppercase hexadecimal characters:
   import {Random, Entropy} from 'entropy-string'
   
   const random = new Random('0123456789ABCDEF')
-  const bits = Entropy.bitsWithPowers(6, 9)
+  const bits = Entropy.bits(1e6, 1e9)
   
   const string = random.string(bits)
   ```
@@ -234,13 +234,13 @@ Finally, given that the strings are 12 hexadecimals long, each string actually h
 
 In [Real Need](#RealNeed) our developer used hexadecimal characters for the strings.  Let's look at using other characters instead.
 
-We'll start with using 32 characters. What 32 characters, you ask? The [Character Sets](#CharacterSets) section discusses the predefined characters available in `entropy-string` and the [Custom Characters](#CustomCharacters) section describes how you can use whatever characters you want. By default, `entropy-string` uses `charSet32` characters, so we don't need to pass that parameter into `new Random()`. We also use `bitsWithRiskPower` that allows passing the `risk` as a power of 10.
+We'll start with using 32 characters. What 32 characters, you ask? The [Character Sets](#CharacterSets) section discusses the predefined characters available in `entropy-string` and the [Custom Characters](#CustomCharacters) section describes how you can use whatever characters you want. By default, `entropy-string` uses `charSet32` characters, so we don't need to pass that parameter into `new Random()`.
 
   ```js
   import {Random, Entropy} from 'entropy-string'
 
   const random = new Random()
-  const bits = Entropy.bitsWithRiskPower(10000, 6)
+  const bits = Entropy.bits(10000, 1e6)
   const string = random.string(bits)
   ```
 
@@ -277,7 +277,7 @@ Suppose we have a more extreme need. We want less than a 1 in a trillion chance
   import {Random, Entropy} from 'entropy-string'
 
   const random = new Random()
-  const bits = Entropy.bitsWithPowers(10, 12)
+  const bits = Entropy.bits(1e10, 1e12)
   const string = random.string(bits)
   ```
 
@@ -516,7 +516,7 @@ Note the number of bytes needed is dependent on the number of characters in our
   import {Random, Entropy} from 'entropy-string'
   
   const random = new Random()
-  const bits = Entropy.bitsWithPowers(6,9)
+  const bits = Entropy.bits(1e6,1e9)
   const string = random.string(bits)
   ```
 
diff --git a/dist/lib/entropy.js b/dist/lib/entropy.js
@@ -44,11 +44,13 @@ var bits = function bits(total, risk) {
   return _totalOf(total, _log2(risk));
 };
 
+// CxTBD Mark as obsolete
 var bitsWithRiskPower = function bitsWithRiskPower(total, rPower) {
   var log2Risk = _log2_10 * rPower;
   return _totalOf(total, log2Risk);
 };
 
+// CxTBD Mark as obsolete
 var bitsWithPowers = function bitsWithPowers(tPower, rPower) {
   var N = 0;
   if (tPower < 4) {
diff --git a/examples/more_3.js b/examples/more_3.js
@@ -3,7 +3,7 @@
 import {Random, Entropy} from './entropy-string'
 
 const random = new Random()
-const bits = Entropy.bitsWithPowers(10, 12)
+const bits = Entropy.bits(1e10, 1e12)
 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/tldr2.js b/examples/tldr2.js
@@ -3,7 +3,7 @@
 import {Random, Entropy} from './entropy-string'
   
 const random = new Random()
-const bits = Entropy.bitsWithPowers(6,9)
+const bits = Entropy.bits(1e6,1e9)
 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
@@ -3,7 +3,7 @@
 import {Random, Entropy} from './entropy-string'
 
 const random = new Random()
-const bits = Entropy.bitsWithPowers(6, 9)
+const bits = Entropy.bits(1e6, 1e9)
 
 const string = random.string(bits)
 
diff --git a/examples/tldr_2.js b/examples/tldr_2.js
@@ -4,7 +4,7 @@
 import {Random, Entropy, charSet16} from './entropy-string'
   
 const random = new Random(charSet16)
-const bits = Entropy.bitsWithPowers(6, 9)
+const bits = Entropy.bits(1e6, 1e9)
 
 const string = random.string(bits)
 
diff --git a/examples/tldr_3.js b/examples/tldr_3.js
@@ -3,7 +3,7 @@
 import {Random, Entropy} from './entropy-string'
   
 const random = new Random('0123456789ABCDEF')
-const bits = Entropy.bitsWithPowers(6, 9)
+const bits = Entropy.bits(1e6, 1e9)
 
 const string = random.string(bits)
 
diff --git a/lib/entropy.js b/lib/entropy.js
@@ -23,11 +23,13 @@ const bits = (total, risk) => {
   return _totalOf(total, _log2(risk))
 }
 
+// CxTBD Mark as obsolete
 const bitsWithRiskPower = (total, rPower) => {
   let log2Risk = _log2_10 * rPower
   return _totalOf(total, log2Risk)
 }
 
+// CxTBD Mark as obsolete
 const bitsWithPowers = (tPower, rPower) => {
   let N = 0
   if (tPower < 4) {

Original file line number	Diff line number	Diff line change
`@@ -23,11 +23,13 @@ const bits = (total, risk) => {`
`23`	`23`	`return _totalOf(total, _log2(risk))`
`24`	`24`	`}`
`25`	`25`
	`26`	`+// CxTBD Mark as obsolete`
`26`	`27`	`const bitsWithRiskPower = (total, rPower) => {`
`27`	`28`	`let log2Risk = _log2_10 * rPower`
`28`	`29`	`return _totalOf(total, log2Risk)`
`29`	`30`	`}`
`30`	`31`
	`32`	`+// CxTBD Mark as obsolete`
`31`	`33`	`const bitsWithPowers = (tPower, rPower) => {`
`32`	`34`	`let N = 0`
`33`	`35`	`if (tPower < 4) {`