fix(Morse): Correctly spell omit

BREAKING CHANGE: Change option property omitUnknownCharacter to it's correct spelling
Developmint · Mar 31, 2018 · 257f90f · 257f90f
1 parent ecc282e
commit 257f90f
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 20 deletions.
diff --git a/docs/ciphers/morse.md b/docs/ciphers/morse.md
@@ -17,7 +17,7 @@ The options are the same for both methods, `encode` and `decode`
 const options = {
   separator: ' ', // Custom delimiter or glue
   failOnUnknownCharacter: true, // Should an error be thrown when a character is not included in the alphabet
-  ommitUnknownCharacter: false  // Should unknown character be ommitted or preserverd? (Only if failOnUnknownCharacter is false)
+  omitUnknownCharacter: false  // Should unknown character be omitted or preserverd? (Only if failOnUnknownCharacter is false)
 }
 ```
 
@@ -59,20 +59,20 @@ import { encode } from 'cipher-collection/morse'
 const preserveOptions = {
   separator: '',
   failOnUnknownCharacter: false,
-  ommitUnknownCharacter: false
+  omitUnknownCharacter: false
 }
 
 // Preserve chraracters that can't get encoded
 console.log(encode('€€€', preserveOptions)) // €€€
 
-const ommitOptions = {
+const omitOptions = {
   separator: '',
   failOnUnknownCharacter: false,
-  ommitUnknownCharacter: true
+  omitUnknownCharacter: true
 }
 
-// Ommit chraracters that can't get encoded
-console.log(encode('€€€S', ommitOptions)) // ...
+// omit chraracters that can't get encoded
+console.log(encode('€€€S', omitOptions)) // ...
 ```
 
 
@@ -105,17 +105,17 @@ import { decode } from 'cipher-collection/morse'
 
 const preserveOptions = {
   failOnUnknownCharacter: false,
-  ommitUnknownCharacter: false
+  omitUnknownCharacter: false
 }
 
 // Preserve chraracters that can't get decoded
 console.log(decode('.-.-.-.-.-', preserveOptions)) // .-.-.-.-.-
 
-const ommitOptions = {
+const omitOptions = {
   failOnUnknownCharacter: false,
-  ommitUnknownCharacter: true
+  omitUnknownCharacter: true
 }
 
-// Ommit chraracters that can't get decoded
-console.log(decode('.-.-.-.-.- ...', ommitOptions)) // S
+// omit chraracters that can't get decoded
+console.log(decode('.-.-.-.-.- ...', omitOptions)) // S
 ```
diff --git a/src/morse.js b/src/morse.js
@@ -9,7 +9,7 @@ export const decode = (input, options = {}) => {
     if (options.failOnUnknownCharacter) {
       throw Error('Undecodable character')
     }
-    return options.ommitUnknownCharacter ? '' : c
+    return options.omitUnknownCharacter ? '' : c
   }).join('')
 }
 
@@ -25,7 +25,7 @@ export const encode = (input, options = {}) => {
     if (options.failOnUnknownCharacter) {
       throw Error('Unencodable character')
     }
-    return options.ommitUnknownCharacter ? '' : c
+    return options.omitUnknownCharacter ? '' : c
   }).join(options.separator)
 }
 
@@ -86,7 +86,7 @@ const ALPHABET = {
 const DEFAULT_OPTIONS = {
   separator: ' ',
   failOnUnknownCharacter: true,
-  ommitUnknownCharacter: false
+  omitUnknownCharacter: false
 }
 export default {
   decode,

diff --git a/test/morse.test.js b/test/morse.test.js
@@ -7,12 +7,12 @@ const encodedAlphabet = '.- -... -.-. -.. . ..-. --. .... .. .--- -.- .-.. -- -.
 const invalidCharacter = {
   input: '€S',
   preserve: '€...',
-  ommit: '...'
+  omit: '...'
 }
 const invalidMorseCharacter = {
   input: '.-.-.-.-.-.- ...',
   preserve: '.-.-.-.-.-.-S',
-  ommit: 'S'
+  omit: 'S'
 }
 
 describe('decoding', () => {
@@ -33,8 +33,8 @@ describe('decoding', () => {
     })).toBe(invalidMorseCharacter.preserve)
     expect(morse.decode(invalidMorseCharacter.input, {
       failOnUnknownCharacter: false,
-      ommitUnknownCharacter: true
-    })).toBe(invalidMorseCharacter.ommit)
+      omitUnknownCharacter: true
+    })).toBe(invalidMorseCharacter.omit)
   })
 })
 describe('encoding', () => {
@@ -50,7 +50,7 @@ describe('encoding', () => {
     expect(morse.encode(invalidCharacter.input, {
       separator: '',
       failOnUnknownCharacter: false,
-      ommitUnknownCharacter: true
-    })).toBe(invalidCharacter.ommit)
+      omitUnknownCharacter: true
+    })).toBe(invalidCharacter.omit)
   })
 })