fix doc and version bump

questdb · Sep 18, 2023 · 52cfc03 · 52cfc03
1 parent d7e67f5
commit 52cfc03
Show file tree

Hide file tree

Showing 12 changed files with 18 additions and 18 deletions.
diff --git a/docs/Sender.html b/docs/Sender.html
@@ -2396,7 +2396,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 Sep 18 2023 16:36:41 GMT+0300 (Eastern European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Sep 18 2023 15:34:51 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/index.html b/docs/index.html
@@ -248,7 +248,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 Sep 18 2023 16:36:41 GMT+0300 (Eastern European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Sep 18 2023 15:34:51 GMT+0100 (British Summer 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 Sep 18 2023 16:36:41 GMT+0300 (Eastern European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Sep 18 2023 15:34:51 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/module-@questdb_nodejs-client.html b/docs/module-@questdb_nodejs-client.html
@@ -27,7 +27,7 @@ <h1 class="page-title">Module: @questdb/nodejs-client</h1>
 <section>
 
 <header>
-    
+
 </header>
 
 <article>
@@ -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 Sep 18 2023 16:36:41 GMT+0300 (Eastern European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Sep 18 2023 15:34:51 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/src_sender.js.html b/docs/src_sender.js.html
@@ -547,7 +547,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 Sep 18 2023 16:36:41 GMT+0300 (Eastern European Summer Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Sep 18 2023 15:34:51 GMT+0100 (British Summer Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@questdb/nodejs-client",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "QuestDB Node.js Client",
   "main": "index.js",
   "types": "types/index.d.ts",

diff --git a/src/validation.js b/src/validation.js
@@ -123,7 +123,7 @@ function validateColumnName(name) {
  * Validates a designated timestamp. The value must contain only digits.<br>
  * Throws an error if the value is invalid.
  *
- * @param {string | bigint} timestamp - The timestamp name to validate.
+ * @param {string | bigint} timestamp - The timestamp to validate.
  */
 function validateDesignatedTimestamp(timestamp) {
     if (typeof timestamp === "string") {

diff --git a/types/src/sender.d.ts b/types/src/sender.d.ts
@@ -150,16 +150,16 @@ export class Sender {
      * Write a timestamp column with its value into the buffer of the sender.
      *
      * @param {string} name - Column name.
-     * @param {number} value - Column value, accepts only number objects.
+     * @param {number | bigint} value - Epoch timestamp in microseconds, accepts only numbers or BigInts.
      * @return {Sender} Returns with a reference to this sender.
      */
-    timestampColumn(name: string, value: number): Sender;
+    timestampColumn(name: string, value: number | bigint): Sender;
     /**
      * Closing the row after writing the designated timestamp into the buffer of the sender.
      *
-     * @param {string} timestamp - A string represents the designated timestamp in nanoseconds.
+     * @param {string | bigint} timestamp - A string or BigInt that represents the designated timestamp in epoch nanoseconds.
      */
-    at(timestamp: string): void;
+    at(timestamp: string | bigint): void;
     /**
      * Closing the row without writing designated timestamp into the buffer of the sender. <br>
      * Designated timestamp will be populated by the server on this record.

diff --git a/types/src/sender.d.ts.map b/types/src/sender.d.ts.map
diff --git a/types/src/validation.d.ts b/types/src/validation.d.ts
@@ -16,7 +16,7 @@ export function validateColumnName(name: string): void;
  * Validates a designated timestamp. The value must contain only digits.<br>
  * Throws an error if the value is invalid.
  *
- * @param {string} timestamp - The table name to validate.
+ * @param {string | bigint} timestamp - The timestamp to validate.
  */
-export function validateDesignatedTimestamp(timestamp: string): void;
+export function validateDesignatedTimestamp(timestamp: string | bigint): void;
 //# sourceMappingURL=validation.d.ts.map
diff --git a/types/src/validation.d.ts.map b/types/src/validation.d.ts.map