From 3460abdd967690cf44476d62646947774ba90f3f Mon Sep 17 00:00:00 2001
From: Timothy J Warren <tim@timshomepage.net>
Date: Mon, 21 Nov 2016 19:48:00 -0500
Subject: [PATCH] Documentation updates

---
 lib/Adapter.js                    |  2 +-
 lib/QueryBuilder.js               | 10 +++++-----
 lib/QueryParser.js                |  2 +-
 lib/adapters/MSSQLServer/index.js |  5 +++++
 lib/drivers/MSSQLDriver.js        | 17 +++++++++++++++++
 lib/helpers.js                    |  2 +-
 6 files changed, 30 insertions(+), 8 deletions(-)
 create mode 100644 lib/drivers/MSSQLDriver.js

diff --git a/lib/Adapter.js b/lib/Adapter.js
index e0c36ed..772e341 100755
--- a/lib/Adapter.js
+++ b/lib/Adapter.js
@@ -22,7 +22,7 @@ class Adapter {
 	 *
 	 * @param {String} sql - The sql with placeholders
 	 * @param {Array} params - The values to insert into the query
-	 * @return {Promise} - returns a promise if no callback is passed
+	 * @return {Promise} - returns a promise resolving to the result of the database query
 	 */
 	execute (sql, params) {
 		throw new Error('Correct adapter not defined for query execution');
diff --git a/lib/QueryBuilder.js b/lib/QueryBuilder.js
index 268fd10..9460c1d 100755
--- a/lib/QueryBuilder.js
+++ b/lib/QueryBuilder.js
@@ -490,7 +490,7 @@ class QueryBuilder extends QueryBuilderBase {
 	 * @example query.get('table_name').then(promiseCallback); // Get all the rows in the table
 	 * @example query.get('table_name', 5); // Get 5 rows from the table
 	 * @example query.get(); // Get the results of a query generated with other methods
-	 * @return {void|Promise} - If no callback is passed, a promise is returned
+	 * @return {Promise<Result>} - Promise containing the result of the query
 	 */
 	get (table, limit, offset) {
 		if (table) {
@@ -510,7 +510,7 @@ class QueryBuilder extends QueryBuilderBase {
 	 *
 	 * @param {String} table - The table to insert into
 	 * @param {Object} [data] - Data to insert, if not already added with the 'set' method
-	 * @return {Promise} - If no callback is passed, a promise is returned
+	 * @return {Promise<Result>} - Promise containing the result of the query
 	 */
 	insert (table, data) {
 		if (data) {
@@ -528,7 +528,7 @@ class QueryBuilder extends QueryBuilderBase {
 	 * @param {Array} data - The array of objects containing data rows to insert
 	 * @example query.insertBatch('foo',[{id:1,val:'bar'},{id:2,val:'baz'}])
 	 *.then(promiseCallback);
-	 * @return {Promise} - If no callback is passed, a promise is returned
+	 * @return {Promise<Result>} - Promise containing the result of the query
 	 */
 	insertBatch (table, data) {
 		let batch = this.driver.insertBatch(table, data);
@@ -542,7 +542,7 @@ class QueryBuilder extends QueryBuilderBase {
 	 *
 	 * @param {String} table - The table to insert into
 	 * @param {Object} [data] - Data to insert, if not already added with the 'set' method
-	 * @return {Promise} - If no callback is passed, a promise is returned
+	 * @return {Promise<Result>} - Promise containing the result of the query
 	 */
 	update (table, data) {
 		if (data) {
@@ -558,7 +558,7 @@ class QueryBuilder extends QueryBuilderBase {
 	 *
 	 * @param {String} table - The table to insert into
 	 * @param {Object} [where] - Where clause for delete statement
-	 * @return {Promise} - If no callback is passed, a promise is returned
+	 * @return {Promise<Result>} - Promise containing the result of the query
 	 */
 	delete (table, where) {
 		if (where) {
diff --git a/lib/QueryParser.js b/lib/QueryParser.js
index e162385..27a140a 100644
--- a/lib/QueryParser.js
+++ b/lib/QueryParser.js
@@ -115,7 +115,7 @@ class QueryParser {
 	/**
 	 * Return the output of the parsing of the join condition
 	 *
-	 * @param {String} condition - The join condition to evalate
+	 * @param {String} condition - The join condition to evaluate
 	 * @return {String} - The parsed/escaped join condition
 	 */
 	compileJoin (condition) {
diff --git a/lib/adapters/MSSQLServer/index.js b/lib/adapters/MSSQLServer/index.js
index e69de29..5c41b25 100644
--- a/lib/adapters/MSSQLServer/index.js
+++ b/lib/adapters/MSSQLServer/index.js
@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = config => {
+
+};
diff --git a/lib/drivers/MSSQLDriver.js b/lib/drivers/MSSQLDriver.js
new file mode 100644
index 0000000..0deab0f
--- /dev/null
+++ b/lib/drivers/MSSQLDriver.js
@@ -0,0 +1,17 @@
+'use strict';
+
+/**
+ * Driver for Microsoft SQL Server databases
+ *
+ * @module drivers/MSSQLDriver
+ */
+module.exports = (() => {
+	delete require.cache[require.resolve('../Driver')];
+	const driver = require('../Driver');
+	const helpers = require('../helpers');
+
+	driver.identifierStartChar = '[';
+	driver.identifierEndChar = ']';
+
+	return driver;
+})();
diff --git a/lib/helpers.js b/lib/helpers.js
index afb08d4..8735b80 100755
--- a/lib/helpers.js
+++ b/lib/helpers.js
@@ -5,7 +5,7 @@
  *
  * @private
  */
-let helpers = {
+const helpers = {
 	/**
 	 * Wrap String.prototype.trim in a way that is easily mappable
 	 *