Merge pull request #4 from sogoagain/issue3_rename

rename option parameter 'charactersToUseWhenScrambling' to 'characters'

README.md

@@ -58,7 +58,7 @@ scrambler.scramble('- Friedrich Nietzsche -', handleScramble);
 
 // call scramble with the option to set the characters to use when scrambled.
 scrambler.scramble(text, handleScramble, {
-  charactersToUseWhenScrambling: ['a', 'b', 'c'],
+  characters: ['a', 'b', 'c'],
 });
 
 // Scrambler provides several characters.

examples/index.html

@@ -43,7 +43,7 @@ <h1 id="text"></h1>
       const targetText = TEXTS[i % TEXTS.length];
       if (i == 2) {
         scrambler.scramble(targetText, handleScramble, {
-          charactersToUseWhenScrambling: Scrambler.CHARACTERS.ALPHABET,
+          characters: Scrambler.CHARACTERS.ALPHABET,
         });
       } else {
         scrambler.scramble(targetText, handleScramble);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "scrambling-text",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "A very simple JavaScript library written in vanilla js for scrambling text.",
   "main": "dist/scrambling-text.js",
   "scripts": {

src/Scrambler.js

@@ -7,7 +7,7 @@ export default class Scrambler {
   }
 
   constructor() {
-    this.charactersToUseWhenScrambling = [...Scrambler.CHARACTERS.DEFAULT];
+    this.characters = [...Scrambler.CHARACTERS.DEFAULT];
     this.maxCounter = 12;
 
     this.targetText = '';
@@ -21,10 +21,10 @@ export default class Scrambler {
   }
 
   scramble(text, onScramble, option = null) {
-    if (option?.charactersToUseWhenScrambling) {
-      this.charactersToUseWhenScrambling = [...option.charactersToUseWhenScrambling];
+    if (option?.characters) {
+      this.characters = [...option.characters];
     } else {
-      this.charactersToUseWhenScrambling = [...Scrambler.CHARACTERS.DEFAULT];
+      this.characters = [...Scrambler.CHARACTERS.DEFAULT];
     }
     this.targetText = text;
     this.encodingCounters = this._generateCounters(this.scrambledText);
@@ -40,8 +40,8 @@ export default class Scrambler {
   _randomText(length) {
     let text = '';
     for (let i = 0; i < length; i += 1) {
-      text += this.charactersToUseWhenScrambling[
-        Math.floor(Math.random() * this.charactersToUseWhenScrambling.length)
+      text += this.characters[
+        Math.floor(Math.random() * this.characters.length)
       ];
     }
     return text;
@@ -108,8 +108,8 @@ export default class Scrambler {
           decodingText += this.targetText[i];
           continue;
         }
-        decodingText += this.charactersToUseWhenScrambling[Math.floor(
-          Math.random() * this.charactersToUseWhenScrambling.length,
+        decodingText += this.characters[Math.floor(
+          Math.random() * this.characters.length,
         )];
         this.decodingCounters[i] -= 1;
       }

src/Scrambler.test.js

@@ -34,7 +34,7 @@ describe('Scrambler', () => {
 
       texts.forEach((text) => {
         scrambler.scramble(text, handleScramble, {
-          charactersToUseWhenScrambling: ['a', 'b', 'c'],
+          characters: ['a', 'b', 'c'],
         });
         expect(handleScramble).toHaveBeenLastCalledWith(text);
       });