Add jsdoc

r-spacex · Mar 2, 2018 · 2ff9d74 · 2ff9d74
1 parent c580cda
commit 2ff9d74
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 5 deletions.
diff --git a/src/builders/launch-query.js b/src/builders/launch-query.js
@@ -2,7 +2,6 @@
 // Required to correctly output ObjectID's
 const ObjectId = require('mongodb').ObjectID;
 
-
 /**
  * Builds Mongo query for past/upcoming launch endpoints from querystrings
  * @param {Object} req The Express request object to access querystrings

diff --git a/src/builders/launch-sort.js b/src/builders/launch-sort.js
@@ -1,10 +1,14 @@
-/**
- * Returns sorting query for past/upcoming launches
-*/
 
+// Prevent incorrect input
 const lowerCase = require('lower-case');
 
-exports.launchSort = (req) => {
+/**
+ * Builds Mongo sort object to set document order
+ * @param {Object} req The Express request object to access querystrings
+ * @return {Object} Mongo compatible sort object
+ */
+
+module.exports.launchSort = (req) => {
   const query = {};
 
   if (lowerCase(req.query.order) === 'asc') {