documentation

src/utils/facilityUtils.js

@@ -236,6 +236,13 @@ const getEntriesByDay = (schedule, dayOfWeek) => {
     return entries;
 };
 
+/**
+ * returns the hours open in the format 10am - 9pm for example
+ *
+ * @param facility object
+ * @param dayOfWeek The day of the week
+ * @returns {array} array of objects with text,start,end,allDayOrClosed properties.
+ */
 const getHoursByDay = (facility, dayOfWeek) => {
     const schedule = getFacilityActiveSchedule(facility);
 

src/utils/mapboxUtils.js

+/**
+ * paints geojson data onto map
+ *
+ * @param map object
+ * @param geojson object
+ */
 const addRoute = (map, geometry) => {
     map.addLayer({
         id: 'route',
@@ -20,7 +26,14 @@ const addRoute = (map, geometry) => {
         }
     });
 };
-
+/**
+ * Gets directions from start coord to end cood and returns a geojson line object
+ *
+ * @param mapbox client object
+ * @param start coordinate
+ * @param end coordinate
+ * @returns {Promise} the line object
+ */
 const getGeoLine = (mapboxClient, start, end) => {
 
     return new Promise((resolve) => {
@@ -37,7 +50,11 @@ const getGeoLine = (mapboxClient, start, end) => {
         );
     });
 };
-
+/**
+ * Calculates the number of days between dayFrom and dayTo.
+ *
+ * @returns {array} the bounds of the George Mason Fairfax Campus
+ */
 const getMaxBounds = () => {
     return [
         [-77.321649, 38.823919], // Southwest coordinates

src/utils/nameUtils.js

+/**
+ * removes the building name in brackets
+ *
+ * @param cleaned name
+
+ * @returns {Promise} the line object
+ */
 export const removeBrackets = (name) => {
     if (typeof (name) === 'undefined') {
         return '';