From 31b0aedc9e1c63ad4efebac5a367949a9f31e0ba Mon Sep 17 00:00:00 2001
From: Timothy J Warren
Date: Fri, 18 Nov 2016 22:35:21 -0500
Subject: [PATCH] More documentation updates
---
API.md | 10 +++++-----
docs/index.html | 30 +++++++++++++++---------------
lib/adapters/MSSQLServer/index.js | 0
3 files changed, 20 insertions(+), 20 deletions(-)
create mode 100644 lib/adapters/MSSQLServer/index.js
diff --git a/API.md b/API.md
index 4fd79c7..6e294e3 100644
--- a/API.md
+++ b/API.md
@@ -418,7 +418,7 @@ query.get('table_name', 5); // Get 5 rows from the table
query.get(); // Get the results of a query generated with other methods
```
-Returns **(void | [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise))** If no callback is passed, a promise is returned
+Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Result](#result)>** Promise containing the result of the query
## insert
@@ -429,7 +429,7 @@ Run the generated insert query
- `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The table to insert into
- `data` **\[[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** Data to insert, if not already added with the 'set' method
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** If no callback is passed, a promise is returned
+Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Result](#result)>** Promise containing the result of the query
## insertBatch
@@ -447,7 +447,7 @@ query.insertBatch('foo',[{id:1,val:'bar'},{id:2,val:'baz'}])
.then(promiseCallback);
```
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** If no callback is passed, a promise is returned
+Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Result](#result)>** Promise containing the result of the query
## update
@@ -458,7 +458,7 @@ Run the generated update query
- `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The table to insert into
- `data` **\[[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** Data to insert, if not already added with the 'set' method
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** If no callback is passed, a promise is returned
+Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Result](#result)>** Promise containing the result of the query
## delete
@@ -469,7 +469,7 @@ Run the generated delete query
- `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The table to insert into
- `where` **\[[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** Where clause for delete statement
-Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** If no callback is passed, a promise is returned
+Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Result](#result)>** Promise containing the result of the query
## getCompiledSelect
diff --git a/docs/index.html b/docs/index.html
index 6431149..aec3a2a 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -2826,7 +2826,7 @@ prefixed with 'OR NOT'
Get the results of the compiled query
-
+
@@ -2872,8 +2872,8 @@ prefixed with 'OR NOT'
Returns
- (void | Promise)
:
- If no callback is passed, a promise is returned
+ Promise<Result>
:
+ Promise containing the result of the query
@@ -2920,7 +2920,7 @@ prefixed with 'OR NOT'
Run the generated insert query
-
+
@@ -2958,8 +2958,8 @@ prefixed with 'OR NOT'
Returns
- Promise
:
- If no callback is passed, a promise is returned
+ Promise<Result>
:
+ Promise containing the result of the query
@@ -2994,7 +2994,7 @@ prefixed with 'OR NOT'
Insert multiple sets of rows at a time
-
+
@@ -3032,8 +3032,8 @@ prefixed with 'OR NOT'
Returns
- Promise
:
- If no callback is passed, a promise is returned
+ Promise<Result>
:
+ Promise containing the result of the query
@@ -3075,7 +3075,7 @@ prefixed with 'OR NOT'
Run the generated update query
-
+
@@ -3113,8 +3113,8 @@ prefixed with 'OR NOT'
Returns
- Promise
:
- If no callback is passed, a promise is returned
+ Promise<Result>
:
+ Promise containing the result of the query
@@ -3149,7 +3149,7 @@ prefixed with 'OR NOT'
Run the generated delete query
-
+
@@ -3187,8 +3187,8 @@ prefixed with 'OR NOT'
Returns
- Promise
:
- If no callback is passed, a promise is returned
+ Promise<Result>
:
+ Promise containing the result of the query
diff --git a/lib/adapters/MSSQLServer/index.js b/lib/adapters/MSSQLServer/index.js
new file mode 100644
index 0000000..e69de29