feat(common): add lessThan function with tests (#166)

Author: lockround

src/index.js

@@ -7,6 +7,7 @@ import flatten from './flatten'
 import getQueryStringParam from './get-query-string-param'
 import snakeToCamel from './snake-to-camel'
 import padLeft from './pad-left'
+import lessThan from './less-than'
 import randomInteger from './random-integer'
 import arrayFill from './array-fill'
 import sortObjectsArray from './sort-objects-array'
@@ -120,4 +121,5 @@ export {
   reverse,
   removeAccents,
   getQueryStringValue,
+  lessThan,
 }

src/less-than.js

@@ -0,0 +1,12 @@
+export default lessThan
+
+/**
+ * This method will check if num1 is less than num2
+ *
+ * @param {Number} num1 - first number
+ * @param {Number} num2 - second  number
+ * @return {Boolean} - Returns true if num1 is less than num2, else false.
+ */
+function lessThan(num1, num2) {
+  return num1 < num2
+}

test/less-than.test.js

@@ -0,0 +1,10 @@
+import test from 'ava'
+import {lessThan} from '../src'
+
+test('checks if num1 is less than num2', t => {
+    const num1 = 1
+    const num2 = 2
+    const expected = true
+    const actual = lessThan(num1, num2)
+    t.deepEqual(actual, expected)
+})