chore(nodejs): doc fix

Author: glasstiger

docs/Sender.html

@@ -1095,7 +1095,7 @@ <h5>Returns:</h5>
 
 
 
-    <h4 class="name" id="flush"><span class="type-signature">(async) </span>flush<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
+    <h4 class="name" id="flush"><span class="type-signature">(async) </span>flush<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;boolean>}</span></h4>
 
 
 
@@ -1177,7 +1177,7 @@ <h5>Returns:</h5>
 
 
 <div class="param-desc">
-    Returns true if there was data in the buffer to send.
+    Resolves to true if there was data in the buffer to send.
 </div>
 
 
@@ -1188,7 +1188,7 @@ <h5>Returns:</h5>
     </dt>
     <dd>
 
-<span class="param-type">boolean</span>
+<span class="param-type">Promise.&lt;boolean></span>
 
 
     </dd>
@@ -2359,7 +2359,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-@q
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 11:44:43 GMT+0100 (British Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 11:54:33 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/index.html

@@ -176,7 +176,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-@q
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 11:44:43 GMT+0100 (British Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 11:54:33 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/index.js.html

@@ -53,7 +53,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-@q
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 11:44:43 GMT+0100 (British Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 11:54:33 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/module-@questdb_nodejs-client.html

@@ -156,7 +156,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-@q
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 11:44:43 GMT+0100 (British Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 11:54:33 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

docs/src_sender.js.html

@@ -185,7 +185,7 @@ <h1 class="page-title">Source: src/sender.js</h1>
      * Sends the buffer's content to the database and compacts the buffer.
      * If the last row is not finished it stays in the sender's buffer.
      *
-     * @return {boolean} Returns true if there was data in the buffer to send.
+     * @return {Promise&lt;boolean>} Resolves to true if there was data in the buffer to send.
      */
     async flush() {
         const data = this.toBuffer(this.endOfLastRow);
@@ -508,7 +508,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-@q
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 11:44:43 GMT+0100 (British Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 11:54:33 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@questdb/nodejs-client",
-  "version": "0.0.33",
+  "version": "0.0.34",
   "description": "QuestDB Node.js Client",
   "main": "index.js",
   "types": "types/index.d.ts",

src/sender.js

@@ -157,7 +157,7 @@ class Sender {
      * Sends the buffer's content to the database and compacts the buffer.
      * If the last row is not finished it stays in the sender's buffer.
      *
-     * @return {boolean} Returns true if there was data in the buffer to send.
+     * @return {Promise<boolean>} Resolves to true if there was data in the buffer to send.
      */
     async flush() {
         const data = this.toBuffer(this.endOfLastRow);

types/src/sender.d.ts

@@ -70,9 +70,9 @@ export class Sender {
      * Sends the buffer's content to the database and compacts the buffer.
      * If the last row is not finished it stays in the sender's buffer.
      *
-     * @return {boolean} Returns true if there was data in the buffer to send.
+     * @return {Promise<boolean>} Resolves to true if there was data in the buffer to send.
      */
-    flush(): boolean;
+    flush(): Promise<boolean>;
     /**
      * @ignore
      * @return {Buffer} Returns a cropped buffer ready to send to the server or null if there is nothing to send.