0.2.0 (base function set w/o timedLoops)

Author: csokolove

.gitignore

@@ -1,2 +1,7 @@
 node_modules
-package-lock.json
+package-lock.json
+tests
+
+# WIP functions
+bin/stopTimedLoop.js
+bin/timedLoop.js

README.md

@@ -13,6 +13,7 @@ code-org is a **WIP** module to allow utilization of JavaScript functions from [
 - [Code.org App Lab Docs](https://studio.code.org/docs/applab/)
 *Our endgoal for this project is to have all relevant functions added to this module from App Lab*
 - [GitHub](https://github.com/csokolove/code-org)
+- [Project Map](https://github.com/users/csokolove/projects/1/views/1)
 
 ## Contributing
 

bin/addPair.js

@@ -0,0 +1,17 @@
+/**
+ * Add a new key/value pair to an existing object.
+ * @param {Object} object The object to add the key and value pair.
+ * @param {String} key The name of the key to look up the value for in the object.
+ * @param {*} value The value to store in the object under the key provided.
+ * @link https://studio.code.org/docs/applab/addPair/
+ */
+
+const addPair = (object, key, value) => {
+    if(!arguments[2]) throw new Error('All parameters are required');
+    if (typeof(object) !== 'object') throw new TypeError('The object must be a valid object');
+    if (typeof(key) !== 'string') throw new TypeError('The key must be a valid string');
+
+    object[key] = value;
+}
+
+module.exports = addPair;

bin/appendItem.js

@@ -0,0 +1,17 @@
+/**
+ * Appends an item to the end of an array.
+ * @param {Object} array The variable name of the array (list) you want to append to the end of.
+ * @param {*} item The number or string item to be inserted at the end of the list.
+ * @link https://studio.code.org/docs/applab/appendItem/
+ */
+
+const appendItem = (array, item) => {
+    if (!arguments[1]) throw new Error('All parameters are required'); 
+    if (typeof(array) !== 'object') throw new TypeError('Array must be referenced as a variable');
+
+    // JavaScript will natively catch if the array referenced is undefined
+    
+    array.splice(array.length, 0, item)
+}
+
+module.exports = appendItem;

bin/getTime.js

@@ -1,6 +1,7 @@
 /**
- * 
- * @returns Number of milliseconds elapsed since UNIX Epoch (January 1, 1970)
+ * Gets the number of milliseconds elapsed since January 1, 1970.
+ * @returns Returns the number of milliseconds elapsed since January 1, 1970.
+ * @link https://studio.code.org/docs/applab/getTime/
  */
 
 const getTime = () => {

bin/getValue.js

@@ -0,0 +1,15 @@
+/**
+ * Gets the value associated with a specific `key` in an object.
+ * @param {Object} object The object to access the value from.
+ * @param {String} key The name of the key to look up the value for in `object`.
+ * @link https://studio.code.org/docs/applab/getValue/
+ */
+
+const getValue = (object, key) => {
+    if (typeof(object) !== 'object') throw new TypeError('The object must be a valid object');
+    if (typeof(key) !== 'string') throw new TypeError('The key must be a valid string');
+
+    return object[key];
+}
+
+module.exports = getValue;

bin/insertItem.js

@@ -0,0 +1,27 @@
+/**
+ * Inserts an item into an array at the specified index position.
+ * @param {Object} array The variable name of the array (list) you want to insert the item into.
+ * @param {Number} index 	The index position you want to insert the item at.
+ * @param {*} item 	The number or string item to be inserted into the list.
+ * @link https://studio.code.org/docs/applab/insertItem/
+ */
+
+const insertItem = (array, index, item) => {
+    if (!arguments[2]) throw new Error('All parameters are required');
+    if (typeof(array) !== 'object') throw new TypeError('Array must be referenced as a variable');
+
+    // JavaScript will natively catch if the array referenced is undefined
+
+    if (isNaN(index)) {
+        index = parseInt(index)
+        if (isNaN(index)) {
+            array.unshift(item);
+        } else {
+            array.splice(index, 0, item);
+        }
+    } else {
+        array.splice(index, 0, item)
+    }
+}
+
+module.exports = insertItem;

bin/open.js

@@ -0,0 +1,26 @@
+const openPkg = require('open');
+const colors = require('colors');
+
+/**
+ * Open a URL in the computer's default browser
+ * @param {String} url - The URL to open
+ * @example https://code.org (valid URL)
+ * @example www.code.org (gray area, providing a protocol is recommended)
+ * @example code.org (invalid URL)
+ * @link https://studio.code.org/docs/applab/open/
+ */
+
+const open = async (url) => {
+    if (typeof(url) !== 'string') throw new TypeError('URL must be a string');
+
+    try {
+        new URL(url);
+        console.log(colors.yellow(`WARNING: The function open() is opening a URL in your default browser (${url})`))
+        await openPkg(url);
+    } catch (_) {
+        console.log(`Attempting to open requested URL (${url}), however it may be malformed. It is highly recommended to provide a protocol in the URL`)
+        await openPkg(url);
+    }
+}
+
+module.exports = open;

bin/prompt.js

@@ -0,0 +1,37 @@
+const readline = require('readline');
+const util = require('util');
+
+/**
+ * Prompts the user for a value
+ * @async Utilize IIFE to immediately call the function.
+ * @param query - Value that will be sent to the user when prompted to answer
+ * @returns Input received from the user
+ * @example (async () => {
+        var firstName = await prompt("What's your famous person's first name?");
+        var lastName = await prompt("What's your famous person's last name?");
+        console.log("Hi " + firstName + " " + lastName); 
+    })();
+  * @link https://studio.code.org/docs/applab/declareAssign_x_prompt/
+ */
+
+const prompt = async (query) => {
+    if (!query) throw new SyntaxError('A query is required to run prompt()');
+    
+    const rl = readline.createInterface({ 
+        input: process.stdin, 
+        output: process.stdout 
+    });
+    
+    const question = util.promisify(rl.question).bind(rl);
+    
+    try {
+        let res = await question(query);
+        rl.close();
+        
+        return res;
+      } catch (err) {
+        throw new Error(`Unable to run prompt() ${err}`);
+      }
+}
+
+module.exports = prompt;

bin/randomNumber.js

@@ -1,7 +1,9 @@
 /**
+ * Returns a random number in the closed range from `min` to `max`.
  * @param {Number} [min=0] - The minimum number returned 
  * @param {Number} max - The maximum number returned
- * @returns Random number in the closed range from min to max
+ * @returns Returns a random number in the range min to max (inclusive). The number returned will always be an integer.
+ * @link https://studio.code.org/docs/applab/randomNumber/
  */
 
 const randomNumber = (min, max) => {
@@ -10,14 +12,14 @@ const randomNumber = (min, max) => {
             min = 0;
             max = 0;
         } else {
-            throw new Error(`${max ? 'Min' : 'Max'} must be a number`);
+            throw new TypeError(`${max ? 'Min' : 'Max'} must be a number`);
         }
     }
 
     if (max === undefined) {
         max = min;
         min = 0;
-    } else if (typeof(max) !== 'number') throw new Error('Max must be a number')
+    } else if (typeof(max) !== 'number') throw new TypeError('Max must be a number')
 
     return Math.floor(Math.random() * (max - min + 1) + min);
 }