Added public method for getting morse characters

Updated README.md

Author: ozdemirburak

README.md

@@ -27,6 +27,7 @@ $ yarn add morsify
 var morsify = require('morsify');
 var encoded = morsify.encode('SOS'); // .../---/... 
 var decoded = morsify.decode('.../---/...'); // S O S
+var characters = morsify.characters(); // {'1': {'A': '.-', ...}, ..., '11': {'ㄱ': '.-..', ...}}
 var audio = morsify.audio('SOS'), oscillator = audio.oscillator; // OscillatorNode
 audio.play(); // play audio
 audio.stop(); // stop audio
@@ -39,6 +40,7 @@ Or alternatively, you can also use the library directly with including the sourc
 <script>
     var encoded = morsify.encode('SOS'); // .../---/... 
     var decoded = morsify.decode('.../---/...'); // S O S
+    var characters = morsify.characters(); // {'1': {'A': '.-', ...}, ..., '11': {'ㄱ': '.-..', ...}}
     var audio = morsify.audio('SOS');
     var oscillator = audio.oscillator; // OscillatorNode
     var context = audio.context; // AudioContext
@@ -72,6 +74,7 @@ Set the priority option according to the list below.
 var cyrillic = morsify.encode('Ленинград', { priority: 5 }) // .-.././-./../-./--./.-./.-/-..
 var greek = morsify.decode('.../.-/--./.-/.--./.--', { priority: 6 }) // Σ Α Γ Α Π Ω
 var hebrew = morsify.decode('––– –... ––– –. ––. .. .–.. –––', { dash: '–', dot: '.', space: ' ', priority: 7 }) // ה ב ה נ ג י ל ה
+var characters = morsify.characters({ dash: '–', dot: '•' }); // {'1': {'A': '•–', ...}, ..., '11': {'ㄱ': '•–••', ...}}
 var arabicAudio = morsify.audio('البُراق‎‎', { // generates the morse .-/.-../-.../.-./.-/--.- then generates the audio from it
   unit: 0.1, // period of one unit, in seconds, 1.2 / c where c is speed of transmission, in words per minute
   oscillator: {

dist/morsify.min.js

@@ -1,15 +1,16 @@
 {
   "name": "morsify",
-  "version": "0.2.4",
+  "version": "0.3.0",
   "description": "Morse code translator and decoder which also generates audio.",
   "keywords": [
     "morse",
-    "morse code",
     "morse alphabet",
     "morse audio",
-    "morse translator",
+    "morse characters",
+    "morse code",
     "morse decoder",
     "morse encoder",
+    "morse translator",
     "morsify"
   ],
   "license": "MIT",

package.json

@@ -90,13 +90,26 @@
     }
   };
 
-  var swapCharacters = function (options) {
-    var swapped = {};
+  var getCharacters = function (opts, usePriority) {
+    var options = getOptions(opts), mapped = {};
     for (var set in characters) {
+      mapped[set] = {};
       for (var key in characters[set]) {
-        var mapped = characters[set][key].replace(/0/g, options.dot).replace(/1/g, options.dash);
-        if (typeof swapped[mapped] === 'undefined') {
-          swapped[mapped] = key;
+        mapped[set][key] = characters[set][key].replace(/0/g, options.dot).replace(/1/g, options.dash);
+      }
+    }
+    if (usePriority !== true) {
+      delete mapped[0];
+    }
+    return mapped;
+  };
+
+  var swapCharacters = function (options) {
+    var swapped = {}, mappedCharacters = getCharacters(options, true);
+    for (var set in mappedCharacters) {
+      for (var key in mappedCharacters[set]) {
+        if (typeof swapped[mappedCharacters[set][key]] === 'undefined') {
+          swapped[mappedCharacters[set][key]] = key;
         }
       }
     }
@@ -192,6 +205,7 @@
   };
 
   return {
+    characters: getCharacters,
     decode: decode,
     encode: encode,
     audio: audio

src/morsify.js

@@ -158,4 +158,30 @@ describe('morsify', function () {
     t.equal(morsify.decode('---/.---/./../-/...', options), 'ㅍ ㅎ ㅏ ㅑ ㅓ ㅕ');
     t.equal(morsify.decode('.-/-./..../.-./-../..-', options), 'ㅗ ㅛ ㅜ ㅠ ㅡ ㅣ');
   });
+  it('returns mapped characters', function () {
+    var characters = morsify.characters();
+    t.equal(characters[1]['A'], '.-');
+    t.equal(characters[2]['0'], '-----');
+    t.equal(characters[3]['.'], '.-.-.-');
+    t.equal(characters[4]['Ç'], '-.-..');
+    t.equal(characters[5]['Я'], '.-.-');
+    t.equal(characters[6]['Ω'], '.--');
+    t.equal(characters[7]['א'], '.-');
+    t.equal(characters[8]['ا'], '.-');
+    t.equal(characters[9]['ا'], '.-');
+    t.equal(characters[10]['ア'], '--.--');
+    t.equal(characters[11]['ㄱ'], '.-..');
+    characters = morsify.characters({ dash: '–', dot: '•', space: ' ' });
+    t.equal(characters[1]['A'], '•–');
+    t.equal(characters[2]['0'], '–––––');
+    t.equal(characters[3]['.'], '•–•–•–');
+    t.equal(characters[4]['Ç'], '–•–••');
+    t.equal(characters[5]['Я'], '•–•–');
+    t.equal(characters[6]['Ω'], '•––');
+    t.equal(characters[7]['א'], '•–');
+    t.equal(characters[8]['ا'], '•–');
+    t.equal(characters[9]['ا'], '•–');
+    t.equal(characters[10]['ア'], '––•––');
+    t.equal(characters[11]['ㄱ'], '•–••');
+  });
 });