Merge pull request #6 from vindecodex/v1.0.x

V1.0.x

README.md

@@ -23,7 +23,7 @@ countWords("Hello World");
 
 Count Characters
 ```JavaScript
-const { countCharacters } require('counting-str');
+const { countCharacters } = require('counting-str');
 countCharacters("Hello World");
 ```
 
@@ -32,11 +32,25 @@ Count Characters without including spaces
 countCharacters("Hello World", { withSpaces: false });
 ```
 
-|Name           | Arguments                     |  Info                                                   |
-|---------------|-------------------------------|---------------------------------------------------------|
-|countWords     | String                        | returns # of words in a string                          |
-|countSpaces    | String                        | returns # of spaces in a string                         |
-|countCharacters| Object { withSpaces: boolean }| withSpaces: true returns # of characters included space |
+Count Vowels
+```JavaScript
+const { countVowels } = require('counting-str');
+countVowels("Hello World");
+```
+
+Count Spaces
+```JavaScript
+const { countSpaces } = require('counting-str');
+countSpaces("Hello World");
+```
+
+|Name            | Arguments                     |  Info                                                   |
+|----------------|-------------------------------|---------------------------------------------------------|
+|countWords      | String                        | returns # of words in a string                          
+|countSpaces     | String                        | returns # of spaces in a string                         
+|countCharacters | Object { withSpaces: boolean }| withSpaces: true returns # of characters included space 
+|countVowels     | String                        | returns # of vowels in a string 
+|countSpaces     | String                        | returns # of spaces in a string 
 
 
 #### Feel free to open a pull request to add more features.

index.js

@@ -1,16 +1,6 @@
 "use strict";
 exports.__esModule = true;
-exports.countCharacters = exports.countSpaces = exports.countWords = exports.countingStr = void 0;
-exports.countingStr = {
-    byWordsLength: 0,
-    bySpacesLength: 0,
-    countWords: function (inputString) {
-        return 0;
-    },
-    countSpaces: function (inputString) {
-        return 0;
-    }
-};
+exports.countVowels = exports.countCharacters = exports.countSpaces = exports.countWords = void 0;
 function countWords(inputString) {
     if (!inputString)
         return 0;
@@ -26,6 +16,7 @@ function countSpaces(inputString) {
 }
 exports.countSpaces = countSpaces;
 function countCharacters(inputString, options) {
+    if (options === void 0) { options = { withSpaces: true }; }
     if (!inputString)
         return 0;
     var inputCharacterSize = inputString.length;
@@ -36,3 +27,9 @@ function countCharacters(inputString, options) {
     return inputCharacterSizeWithoutSpaces;
 }
 exports.countCharacters = countCharacters;
+function countVowels(inputString) {
+    if (!inputString)
+        return 0;
+    return (inputString.match(/[aeiou]/gi) || []).length;
+}
+exports.countVowels = countVowels;

index.ts

@@ -12,11 +12,15 @@ export function countSpaces(inputString: string) {
   let splitWords = inputString.split(" ");
   return splitWords.length - 1;
 }
-export function countCharacters(inputString: string, options: CountCharactersOption) {
+export function countCharacters(inputString: string, options: CountCharactersOption = { withSpaces: true }) {
   if (!inputString) return 0;
   let inputCharacterSize = inputString.length;
   let inputSpaceCharacterSize = inputString.split(" ").length - 1;
   let inputCharacterSizeWithoutSpaces = inputCharacterSize - inputSpaceCharacterSize;
   if (options.withSpaces) return inputCharacterSize;
   return inputCharacterSizeWithoutSpaces;
 }
+export function countVowels(inputString: string) {
+  if (!inputString) return 0;
+  return (inputString.match(/[aeiou]/gi) || []).length;
+}

test/test.js

@@ -3,9 +3,9 @@ const {
   countWords,
   countSpaces,
   countCharacters,
+  countVowels
 } = require('../index.js');
 
-
 const input = "Hello, World!, This is a test";
 
 describe(`Input: ${input}`, null);
@@ -24,7 +24,7 @@ describe('Count Spaces', function() {
 
 describe('Count Characters with spaces', function() {
   it('Should return 29', function() {
-    assert.equal(countCharacters(input, { withSpaces: true }), 29); 
+    assert.equal(countCharacters(input), 29); 
   });
 });
 
@@ -33,3 +33,9 @@ describe('Count Characters without spaces', function() {
     assert.equal(countCharacters(input, { withSpaces: false}), 24);
   });
 });
+
+describe('Count Vowels', function () {
+  it('Should return 7', function () {
+    assert.equal(countVowels(input), 7);
+  });
+});