Merge pull request #70 from variadicjs/minor_changes

Minor changes

Author: jhowardjr

.gitignore

@@ -67,3 +67,5 @@ dist
 .DS_Store
 untitled.sublime-project
 untitled.sublime-workspace
+
+.vscode

DOCUMENTATION.md

@@ -49,7 +49,7 @@ This function converts all numbers to a positive number
 
 ### average
 
-This function caculates the average of the numerical parameters
+This function calculates the average of the numerical parameters
 
 **Parameters**
 
@@ -61,7 +61,7 @@ This function caculates the average of the numerical parameters
 
 ### factorial
 
-This function caculates the factorial of each numerical parameter
+This function calculates the factorial of each numerical parameter
 
 **Parameters**
 

lib/absoluteValue.js

@@ -1,6 +1,6 @@
 
 const handleErrors = (params) => {
-  if (params.length === 0) throw new Error('Must provide one or more paramters');
+  if (params.length === 0) throw new Error('Must provide one or more parameters');
   if (params.some(param => typeof param !== 'number')) {
     throw new Error('One of your parameters does not evaluate to a number');
   }

lib/average.js

@@ -2,7 +2,7 @@ const { sum } = require('./sum');
 const { floatPrecise } = require('./floatPrecise');
 
 const handleErrors = (params) => {
-  if (params.length === 0) throw new Error('Must provide one or more paramters');
+  if (params.length === 0) throw new Error('Must provide one or more parameters');
   if (params.some(param => typeof param !== 'number')) {
     throw new Error('One of your parameters does not evaluate to a number');
   }
@@ -14,7 +14,7 @@ const handleErrors = (params) => {
 };
 
 /**
- * This function caculates the average of the numerical parameters
+ * This function calculates the average of the numerical parameters
  * @memberof variadic
  * @author jmbothe
  * @param {...*} params - One or more parameters.
@@ -26,7 +26,7 @@ exports.average = (...params) => {
 
   // I couldn't actually find any examples of float imprecision
   // when dividing a float by a whole number
-  // so this might not be neccessary. I just put it in for safety's sake - jmbothe
+  // so this might not be necessary. I just put it in for safety's sake - jmbothe
   return floatPrecise(result);
 };
 

lib/factorial.js

@@ -3,7 +3,7 @@
 const { isPositiveInteger } = require('./isPositiveInteger');
 
 const handleErrors = (params) => {
-  if (params.length === 0) throw new Error('Must provide one or more paramters');
+  if (params.length === 0) throw new Error('Must provide one or more parameters');
   if (params.some(param => !Number.isInteger(param))) {
     throw new Error('One of your parameters does not evaluate to a integer');
   }
@@ -19,7 +19,7 @@ const handleErrors = (params) => {
 
 const factorialCache = [1, 1];
 
-const caclulateFactorial = (num) => {
+const calculateFactorial = (num) => {
   if (typeof factorialCache[num] !== 'undefined') {
     return factorialCache[num];
   }
@@ -33,13 +33,13 @@ const caclulateFactorial = (num) => {
 };
 
 /**
- * This function caculates the factorial of each numerical parameter
+ * This function calculates the factorial of each numerical parameter
  * @memberof variadic
  * @author devNoiseConsulting
  * @param {...*} params - One or more parameters.
  */
 exports.factorial = (...params) => {
   handleErrors(params);
 
-  return params.map(caclulateFactorial);
+  return params.map(calculateFactorial);
 };

lib/floatPrecise.js

@@ -6,7 +6,7 @@ exports.floatPrecise = (num) => {
 
   // Reverse loop through number looking for index of last precise digit.
   // Imprecise floats typically contain a long string of 9s or 0s,
-  // somtimes terminating in some other number,
+  // sometimes terminating in some other number,
   // so begin loop at second to last index.
   let i = str.length - 2;
   const imprecise = str[i] === '9' ? '9' : '0';

lib/isAscending.js

@@ -7,7 +7,7 @@
  * @param {...*} params - One or more parameters.
  */
 exports.isAscending = (...params) => {
-  if (params.length < 2) throw new Error('Must provide two or more paramters');
+  if (params.length < 2) throw new Error('Must provide two or more parameters');
   let value = params.shift();
   for (const param of params) {
     if (Number.isNaN(parseFloat(param))) throw new Error('One of your parameters does not evaluate to a number');

lib/isComposit.js

@@ -4,15 +4,15 @@ const { isPrime } = require('./isPrime');
 // `isPrime` checks if the number is an integer greater than 1
 // but since we simply want `isPrime` to check if this number
 // is prime, we need to do the check again to avoid a false result.
-const testComposit = num => (num % 1 || num < 2 ? false : !isPrime(num));
+const testComposite = num => (num % 1 || num < 2 ? false : !isPrime(num));
 
 /**
- * This function evaluates whether all numerical parameters are composit
+ * This function evaluates whether all numerical parameters are composite
  * @memberof variadic
  * @author tdnelson2
  * @param {...*} params - One or more parameters.
  */
 exports.isComposit = (...params) => {
-  if (params.length === 0) throw new Error('Must provide one or more paramters');
-  return params.every(testComposit);
+  if (params.length === 0) throw new Error('Must provide one or more parameters');
+  return params.every(testComposite);
 };

lib/isDescending.js

@@ -7,7 +7,7 @@
  * @param {...*} params - One or more parameters.
  */
 exports.isDescending = (...params) => {
-  if (params.length < 2) throw new Error('Must provide two or more paramters');
+  if (params.length < 2) throw new Error('Must provide two or more parameters');
 
   let value = params.shift();
   for (const param of params) {

lib/isEqual.js

@@ -6,7 +6,7 @@
  * @param {...*} params - One or more parameters.
  */
 exports.isEqual = (...params) => {
-  if (params.length === 0) throw new Error('Must provide one or more paramters');
+  if (params.length === 0) throw new Error('Must provide one or more parameters');
   const firstParam = params.shift();
   for (const param of params) {
     switch (typeof param) {