Finish adding functions

Author: thgaskell

README.md

@@ -3,14 +3,48 @@ js-functions
 
 Javascript Function Exercises
 
+Create 20 functions by following the comments in `functions.js`.
+
+---
+
+numberToString(n)
+-----------------------------
+Converts a number a string.
+
+**Parameters**
+
+**n**: number
+
+**Returns**: string, the number as a string
+
+increase(n)
+-----------------------------
+Adds one to a given number
+
+**Parameters**
+
+**n**: number
+
+**Returns**: number
+
+decrease(n)
+-----------------------------
+Subtracts one from a given number
+
+**Parameters**
+
+**n**: number
+
+**Returns**: number
+
 add(x, y)
 -----------------------------
 Adds two numbers.
 
 **Parameters**
 
 **x**: number
-circumference
+
 **y**: number
 
 **Returns**: number, the sum
@@ -51,19 +85,19 @@ Divides the first number by the second.
 
 **Returns**: number, the quotient
 
-numberToString(n)
+square(x,)
 -----------------------------
-Converts a number a string.
+Multiplies a number by itself.
 
 **Parameters**
 
-**n**: number
+**x,**: number, number to be squared
 
-**Returns**: string, the number as a string
+**Returns**: number, squared
 
 calculate(operation, x, y)
 -----------------------------
-Prints out the equation: (i.e.) "1 + 5 = 6" or "8 / 2 = 4"
+Prints out the equation: (i.e.) "1 + 5 = 6" or "8 / 2 = 4".
 Returns the result.
 
 **Parameters**
@@ -76,6 +110,42 @@ Returns the result.
 
 **Returns**: number, the result
 
+isGreaterThan(x, y)
+-----------------------------
+Returns true if x is greater than y
+
+**Parameters**
+
+**x**: number
+
+**y**: number
+
+**Returns**: boolean, x is larger than y
+
+isLessThan(x, y)
+-----------------------------
+Returns true if x is less than y
+
+**Parameters**
+
+**x**: number
+
+**y**: number
+
+**Returns**: boolean, x is smaller than y
+
+areEqual(x, y)
+-----------------------------
+Returns true if a and b are equal
+
+**Parameters**
+
+**x**: number
+
+**y**: number
+
+**Returns**: boolean, the numbers are equal
+
 minimum(a, b)
 -----------------------------
 Returns the smallest value of two numbers.
@@ -148,16 +218,6 @@ set its `reviews` field to 1.
 **restaurant**: object, represents a restaurant
 
 
-square(x,)
------------------------------
-Multiplies a number by itself.
-
-**Parameters**
-
-**x,**: number, number to be squared
-
-**Returns**: number, squared
-
 combine(word1, word2)
 -----------------------------
 Joins two strings with a space.

functions.js

@@ -0,0 +1,139 @@
+/**
+ * Converts a number a string.
+ * @param {number} n
+ * @return {string} the number as a string
+ */
+
+/**
+ * Adds one to a given number
+ * @param {number} n
+ * @return {number}
+ */
+
+/**
+ * Subtracts one from a given number
+ * @param {number} n
+ * @return {number}
+ */
+
+/**
+ * Adds two numbers.
+ * @param {number} x
+ * @param {number} y
+ * @return {number} the sum
+ */
+
+/**
+ * Subtracts the second number from the first.
+ * @param {number} x
+ * @param {number} y
+ * @return {number} the difference
+ */
+
+/**
+ * Multiplies two numbers.
+ * @param {number} x
+ * @param {number} y
+ * @return {number} the product
+ */
+
+/**
+ * Divides the first number by the second.
+ * @param {number} x
+ * @param {number} y
+ * @return {number} the quotient
+ */
+
+/**
+ * Multiplies a number by itself.
+ * @param {number} x, number to be squared
+ * @return {number} squared
+ */
+
+/**
+ * Prints out the equation: (i.e.) "1 + 5 = 6" or "8 / 2 = 4".
+ * Returns the result.
+ * @param {string} operation "add", "subtract", "multiply", or "divide"
+ * @param {number} x
+ * @param {number} y
+ * @return {number} the result
+ */
+
+/**
+ * Returns true if x is greater than y
+ * @param {number} x
+ * @param {number} y
+ * @return {boolean} x is larger than y
+ */
+
+/**
+ * Returns true if x is less than y
+ * @param {number} x
+ * @param {number} y
+ * @return {boolean} x is smaller than y
+ */
+
+/**
+ * Returns true if a and b are equal
+ * @param {number} x
+ * @param {number} y
+ * @return {boolean} the numbers are equal
+ */
+
+/**
+ * Returns the smallest value of two numbers.
+ * @param {number} a
+ * @param {number} b
+ * @return {number} the smallest number
+ */
+
+/**
+ * Returns the largest value of two numbers.
+ * @param {number} a
+ * @param {number} b
+ * @return {number} the largest number
+ */
+
+/**
+ * Returns true if `n` is even.
+ * @param {number} n
+ * @return {boolean} the number is even
+ */
+
+/**
+ * Returns true if `n` is odd.
+ * @param {number} n
+ * @return {boolean} the number is odd
+ */
+
+/**
+ * Returns a letter grade.
+ * "A": 90-100%
+ * "B": 80-89%
+ * "C": 70-79%
+ * "D": 60-69%
+ * "F": 0-59%
+ * @param {number} score
+ * @param {number} total maximum possible score
+ * @return {string} the score represented as a letter grade
+ */
+
+/**
+ * Checks if arestaurant` object has are `views` field.
+ * If it does, increase it by 1. If it does not,
+ * set itsreviews` field to 1.
+ * @param {object} restaurant represents a restaurant
+ */
+
+/**
+ * Joins two strings with a space.
+ * @param {string} word1
+ * @param {string} word2
+ * @return {string} joined the words joined with a space
+ */
+
+/**
+ * Returns a circle object with the properties `circumferance` and `area`.
+ * @param {number} radius
+ * @return {object} circle
+ */

index.html

@@ -14,6 +14,7 @@
         <script src="lib/js/chai.js" type="text/javascript"></script>
         <script src="lib/js/sinon-chai.js" type="text/javascript"></script>
         <script src="lib/js/sinon.js" type="text/javascript"></script>
+        <script src="functions.js" type="text/javascript"></script>
         <script src="script.js" type="text/javascript"></script>
         <script>mocha.setup('bdd');</script>
         <script src="test/test-script.js"type="text/javascript"></script>

script.js

@@ -1,106 +0,0 @@
-/**
- * Adds two numbers.
- * @param {number} x `
- * @param {number} y `
- * @return {number} the sum
- */
-
-/**
- * Subtracts the second number from the first.
- * @param {number} x `
- * @param {number} y `
- * @return {number} the difference
- */
-
-/**
- * Multiplies two numbers.
- * @param {number} x `
- * @param {number} y `
- * @return {number} the product
- */
-
-/**
- * Divides the first number by the second.
- * @param {number} x `
- * @param {number} y `
- * @return {number} the quotient
- */
-
-/**
- * Converts a number a string.
- * @param {number} n `
- * @return {string} the number as a string
- */
-
-/**
- * Prints out the equation: (i.e.) "1 + 5 = 6" or "8 / 2 = 4".
- * Returns the result.
- * @param {string} operation "add", "subtract", "multiply", or "divide"
- * @param {number} x `
- * @param {number} y `
- * @return {number} the result
- */
-
-/**
- * Returns the smallest value of two numbers.
- * @param {number} a `
- * @param {number} b `
- * @return {number} the smallest number
- */
-
-/**
- * Returns the largest value of two numbers.
- * @param {number} a `
- * @param {number} b `
- * @return {number} the largest number
- */
-
-/**
- * Returns true if `n` is even.
- * @param {number} n `
- * @return {boolean} the number is even
- */
-
-/**
- * Returns true if `n` is odd.
- * @param {number} n `
- * @return {boolean} the number is odd
- */
-
-/**
- * Returns a letter grade.
- * "A": 90-100%
- * "B": 80-89%
- * "C": 70-79%
- * "D": 60-69%
- * "F": 0-59%
- * @param {number} score `
- * @param {number} total maximum possible score
- * @return {string} the score represented as a letter grade
- */
-
-/**
- * Checks if a `restaurant` object has a `reviews` field.
- * If it does, increase it by 1. If it does not,
- * set its `reviews` field to 1.
- * @param {object} restaurant represents a restaurant
- */
-
-/**
- * Multiplies a number by itself.
- * @param {number} x, number to be squared
- * @return {number} squared
- */
-
-/**
- * Joins two strings with a space.
- * @param {string} word1 `
- * @param {string} word2 `
- * @return {string} joined the words joined with a space
- */
-
-/**
- * Returns a circle object with the properties `circumferance` and `area`.
- * @param {number} radius `
- * @return {object} circle
- */