From d97493ae8ca4c72cc7d3da78c01114ffde45ffb9 Mon Sep 17 00:00:00 2001
From: Vytor Calixto <vytorcalixto@gmail.com>
Date: Mon, 12 Sep 2016 11:07:13 -0300
Subject: [PATCH] Add comments to middlewares
---
src/libs/middlewares/dimensions.js | 6 ++++++
src/libs/middlewares/query.js | 6 ++++++
src/libs/middlewares/response.js | 4 ++++
3 files changed, 16 insertions(+)
diff --git a/src/libs/middlewares/dimensions.js b/src/libs/middlewares/dimensions.js
index 8532425c..618a510e 100644
--- a/src/libs/middlewares/dimensions.js
+++ b/src/libs/middlewares/dimensions.js
@@ -12,6 +12,12 @@
* app.use(dimensions())
*/
+/**
+ * This function returns the intersection of two arrays
+ * @param {array} a [description]
+ * @param {array} b [description]
+ * @return {array} [description]
+ */
function intersect(a, b) {
let t;
if (b.length > a.length) {
diff --git a/src/libs/middlewares/query.js b/src/libs/middlewares/query.js
index 7b0cc586..74a0c505 100644
--- a/src/libs/middlewares/query.js
+++ b/src/libs/middlewares/query.js
@@ -2,6 +2,12 @@ const libs = `${process.cwd()}/libs`;
const log = require(`${libs}/log`)(module);
const execQuery = require(`${libs}/db/query_exec`);
+/**
+ * Middleware that executes a query defined by a squel object in req.sql
+ * @param {Object} req [description]
+ * @param {Object} res [description]
+ * @param {Function} next [description]
+ */
function query(req, res, next) {
log.debug(req.sql);
execQuery(req.sql.text, req.sql.values).then((result) => {
diff --git a/src/libs/middlewares/response.js b/src/libs/middlewares/response.js
index 09fa5656..83580825 100644
--- a/src/libs/middlewares/response.js
+++ b/src/libs/middlewares/response.js
@@ -2,6 +2,10 @@ const libs = `${process.cwd()}/libs`;
const log = require(`${libs}/log`)(module);
const xml = require('js2xmlparser');
+/**
+ * Custom generic middleware used to send api responses
+ * @param {string} value text to be used in the xml response
+ */
function response(value) {
return (req, res, next) => {
log.debug(req.query.format);
--
GitLab