small js doc update

questdb · Nov 27, 2023 · 5648bec · 5648bec
1 parent 04cabf3
commit 5648bec
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 8 deletions.
diff --git a/docs/Sender.html b/docs/Sender.html
@@ -132,7 +132,7 @@ <h5>Parameters:</h5>
   If not provided, client is not authenticated and server might reject the connection depending on configuration. <br>
   No type checks performed on the object passed. <br>
   <b>Deprecated</b>, please, use the <i>auth</i> option instead. </li>
-  <li>auth: <i>{kid: string, d: string}</i> - Authentication details, `kid` is the username, `d` is the user's private key <br>
+  <li>auth: <i>{kid: string, d: string}</i> - Authentication details, `kid` is the username, `d` is the user's private key. <br>
   If not provided, client is not authenticated and server might reject the connection depending on configuration. </li>
   <li>log: <i>(level: 'error'|'warn'|'info'|'debug', message: string) => void</i> - logging function. <br>
   If not provided, default logging is used which writes to the console with logging level <i>info</i>. <br>
@@ -2523,7 +2523,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 4.0.2</a> on Mon Nov 27 2023 16:41:07 GMT+0000 (Greenwich Mean Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Mon Nov 27 2023 17:39:18 GMT+0000 (Greenwich Mean Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/index.html b/docs/index.html
@@ -240,7 +240,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 4.0.2</a> on Mon Nov 27 2023 16:41:07 GMT+0000 (Greenwich Mean Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Mon Nov 27 2023 17:39:18 GMT+0000 (Greenwich Mean Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/index.js.html b/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 4.0.2</a> on Mon Nov 27 2023 16:41:07 GMT+0000 (Greenwich Mean Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Mon Nov 27 2023 17:39:18 GMT+0000 (Greenwich Mean Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/module-@questdb_nodejs-client.html b/docs/module-@questdb_nodejs-client.html
@@ -120,7 +120,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 4.0.2</a> on Mon Nov 27 2023 16:41:07 GMT+0000 (Greenwich Mean Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Mon Nov 27 2023 17:39:18 GMT+0000 (Greenwich Mean Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/src_sender.js.html b/docs/src_sender.js.html
@@ -94,7 +94,7 @@ <h1 class="page-title">Source: src/sender.js</h1>
      *   If not provided, client is not authenticated and server might reject the connection depending on configuration. &lt;br>
      *   No type checks performed on the object passed. &lt;br>
      *   &lt;b>Deprecated&lt;/b>, please, use the &lt;i>auth&lt;/i> option instead. &lt;/li>
-     *   &lt;li>auth: &lt;i>{kid: string, d: string}&lt;/i> - Authentication details, `kid` is the username, `d` is the user's private key &lt;br>
+     *   &lt;li>auth: &lt;i>{kid: string, d: string}&lt;/i> - Authentication details, `kid` is the username, `d` is the user's private key. &lt;br>
      *   If not provided, client is not authenticated and server might reject the connection depending on configuration. &lt;/li>
      *   &lt;li>log: &lt;i>(level: 'error'|'warn'|'info'|'debug', message: string) => void&lt;/i> - logging function. &lt;br>
      *   If not provided, default logging is used which writes to the console with logging level &lt;i>info&lt;/i>. &lt;br>
@@ -620,7 +620,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 4.0.2</a> on Mon Nov 27 2023 16:41:07 GMT+0000 (Greenwich Mean Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Mon Nov 27 2023 17:39:18 GMT+0000 (Greenwich Mean Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/src/sender.js b/src/sender.js
@@ -66,7 +66,7 @@ class Sender {
      *   If not provided, client is not authenticated and server might reject the connection depending on configuration. <br>
      *   No type checks performed on the object passed. <br>
      *   <b>Deprecated</b>, please, use the <i>auth</i> option instead. </li>
-     *   <li>auth: <i>{kid: string, d: string}</i> - Authentication details, `kid` is the username, `d` is the user's private key <br>
+     *   <li>auth: <i>{kid: string, d: string}</i> - Authentication details, `kid` is the username, `d` is the user's private key. <br>
      *   If not provided, client is not authenticated and server might reject the connection depending on configuration. </li>
      *   <li>log: <i>(level: 'error'|'warn'|'info'|'debug', message: string) => void</i> - logging function. <br>
      *   If not provided, default logging is used which writes to the console with logging level <i>info</i>. <br>