TimestampUnit type

Author: glasstiger

src/buffer/index.ts

@@ -4,7 +4,7 @@ import { Buffer } from "node:buffer";
 import { log, Logger } from "../logging";
 import { validateColumnName, validateTableName } from "../validation";
 import { SenderOptions } from "../options";
-import { isInteger, timestampToMicros, timestampToNanos } from "../utils";
+import { isInteger, timestampToMicros, timestampToNanos, TimestampUnit } from "../utils";
 
 const DEFAULT_MAX_NAME_LENGTH = 127;
 
@@ -262,11 +262,7 @@ class SenderBuffer {
    * @param {string} [unit=us] - Timestamp unit. Supported values: 'ns' - nanoseconds, 'us' - microseconds, 'ms' - milliseconds. Defaults to 'us'.
    * @return {Sender} Returns with a reference to this sender.
    */
-  timestampColumn(
-    name: string,
-    value: number | bigint,
-    unit: "ns" | "us" | "ms" = "us",
-  ): SenderBuffer {
+  timestampColumn(name: string, value: number | bigint, unit: TimestampUnit = "us"): SenderBuffer {
     if (typeof value !== "bigint" && !Number.isInteger(value)) {
       throw new Error(`Value must be an integer or BigInt, received ${value}`);
     }
@@ -286,7 +282,7 @@ class SenderBuffer {
    * @param {number | bigint} timestamp - Designated epoch timestamp, accepts numbers or BigInts.
    * @param {string} [unit=us] - Timestamp unit. Supported values: 'ns' - nanoseconds, 'us' - microseconds, 'ms' - milliseconds. Defaults to 'us'.
    */
-  at(timestamp: number | bigint, unit: "ns" | "us" | "ms" = "us") {
+  at(timestamp: number | bigint, unit: TimestampUnit = "us") {
     if (!this.hasSymbols && !this.hasColumns) {
       throw new Error("The row must have a symbol or column set before it is closed");
     }

src/sender.ts

@@ -2,7 +2,7 @@
 import { log, Logger } from "./logging";
 import { SenderOptions, ExtraOptions } from "./options";
 import { SenderTransport, createTransport } from "./transport";
-import { isBoolean, isInteger } from "./utils";
+import { isBoolean, isInteger, TimestampUnit } from "./utils";
 import { SenderBuffer } from "./buffer";
 
 const DEFAULT_AUTO_FLUSH_INTERVAL = 1000; // 1 sec
@@ -248,11 +248,7 @@ class Sender {
    * @param {string} [unit=us] - Timestamp unit. Supported values: 'ns' - nanoseconds, 'us' - microseconds, 'ms' - milliseconds. Defaults to 'us'.
    * @return {Sender} Returns with a reference to this sender.
    */
-  timestampColumn(
-    name: string,
-    value: number | bigint,
-    unit: "ns" | "us" | "ms" = "us",
-  ): Sender {
+  timestampColumn(name: string, value: number | bigint, unit: TimestampUnit = "us"): Sender {
     this.buffer.timestampColumn(name, value, unit);
     return this;
   }
@@ -263,7 +259,7 @@ class Sender {
    * @param {number | bigint} timestamp - Designated epoch timestamp, accepts numbers or BigInts.
    * @param {string} [unit=us] - Timestamp unit. Supported values: 'ns' - nanoseconds, 'us' - microseconds, 'ms' - milliseconds. Defaults to 'us'.
    */
-  async at(timestamp: number | bigint, unit: "ns" | "us" | "ms" = "us") {
+  async at(timestamp: number | bigint, unit: TimestampUnit = "us") {
     this.buffer.at(timestamp, unit);
     this.pendingRowCount++;
     this.log("debug", `Pending row count: ${this.pendingRowCount}`);

src/utils.ts

@@ -1,3 +1,5 @@
+type TimestampUnit = "ns" | "us" | "ms";
+
 function isBoolean(value: unknown): value is boolean {
   return typeof value === "boolean";
 }
@@ -8,7 +10,7 @@ function isInteger(value: unknown, lowerBound: number): value is number {
   );
 }
 
-function timestampToMicros(timestamp: bigint, unit: "ns" | "us" | "ms") {
+function timestampToMicros(timestamp: bigint, unit: TimestampUnit) {
   switch (unit) {
     case "ns":
       return timestamp / 1000n;
@@ -17,11 +19,11 @@ function timestampToMicros(timestamp: bigint, unit: "ns" | "us" | "ms") {
     case "ms":
       return timestamp * 1000n;
     default:
-      throw new Error("Unknown timestamp unit: " + unit);
+      throw new Error(`Unknown timestamp unit: ${unit}`);
   }
 }
 
-function timestampToNanos(timestamp: bigint, unit: "ns" | "us" | "ms") {
+function timestampToNanos(timestamp: bigint, unit: TimestampUnit) {
   switch (unit) {
     case "ns":
       return timestamp;
@@ -30,8 +32,8 @@ function timestampToNanos(timestamp: bigint, unit: "ns" | "us" | "ms") {
     case "ms":
       return timestamp * 1000_000n;
     default:
-      throw new Error("Unknown timestamp unit: " + unit);
+      throw new Error(`Unknown timestamp unit: ${unit}`);
   }
 }
 
-export { isBoolean, isInteger, timestampToMicros, timestampToNanos };
+export { isBoolean, isInteger, timestampToMicros, timestampToNanos, TimestampUnit };