Merge pull request #173 from upstash/add-ts-delay-support

feat: add typesafe duration for delays

src/client/client.ts

@@ -1,4 +1,5 @@
 import { DLQ } from "./dlq";
+import type { Duration } from "./duration";
 import { HttpClient, type Requester, type RetryConfig } from "./http";
 import { Chat } from "./llm/chat";
 import type { ProviderReturnType } from "./llm/providers";
@@ -61,7 +62,7 @@ export type PublishRequest<TBody = BodyInit> = {
    *
    * @default undefined
    */
-  delay?: number;
+  delay?: Duration | number;
 
   /**
    * Optionally set the absolute delay of this message.
@@ -141,7 +142,7 @@ export type PublishRequest<TBody = BodyInit> = {
    *
    * @default undefined
    */
-  timeout?: number;
+  timeout?: Duration | number;
 } & (
   | {
       /**

src/client/duration.ts

@@ -0,0 +1,4 @@
+type Unit = "s" | "m" | "h" | "d";
+
+// Using "bigint" instead of "number" as number allows "20 s" while bigint does not.
+export type Duration = `${bigint}${Unit}`;

src/client/messages.test.ts

@@ -69,7 +69,7 @@ describe("Messages", () => {
           url: `https://example.com`,
           body: { hello: "world" },
           timeout: 90,
-          delay: 10,
+          delay: "10d",
         },
       ]);
 

src/client/schedules.ts

@@ -1,6 +1,7 @@
 import { prefixHeaders } from "./utils";
 import type { Requester } from "./http";
 import type { BodyInit, HeadersInit, HTTPMethods } from "./types";
+import type { Duration } from "./duration";
 
 export type Schedule = {
   scheduleId: string;
@@ -50,7 +51,7 @@ export type CreateScheduleRequest = {
    *
    * @default undefined
    */
-  delay?: number;
+  delay?: Duration | number;
 
   /**
    * In case your destination server is unavailable or returns a status code outside of the 200-299
@@ -102,7 +103,7 @@ export type CreateScheduleRequest = {
    *
    * @default undefined
    */
-  timeout?: number;
+  timeout?: Duration | number;
 
   /**
    * Schedule id to use.
@@ -139,7 +140,14 @@ export class Schedules {
     }
 
     if (request.delay !== undefined) {
-      headers.set("Upstash-Delay", `${request.delay.toFixed(0)}s`);
+      // Handle both string (Duration type) and number inputs for delay
+      if (typeof request.delay === "string") {
+        // If delay is a string (e.g., "20s", "1h"), use it directly
+        headers.set("Upstash-Delay", request.delay);
+      } else {
+        // If delay is a number, convert it to seconds and append 's'
+        headers.set("Upstash-Delay", `${request.delay.toFixed(0)}s`);
+      }
     }
 
     if (request.retries !== undefined) {
@@ -155,7 +163,14 @@ export class Schedules {
     }
 
     if (request.timeout !== undefined) {
-      headers.set("Upstash-Timeout", `${request.timeout}s`);
+      // Handle both string (Duration type) and number inputs for timeout
+      if (typeof request.timeout === "string") {
+        // If timeout is a string (e.g., "20s", "1h"), use it directly
+        headers.set("Upstash-Timeout", request.timeout);
+      } else {
+        // If timeout is a number, convert it to seconds and append 's'
+        headers.set("Upstash-Timeout", `${request.timeout}s`);
+      }
     }
 
     if (request.scheduleId !== undefined) {

src/client/utils.ts

@@ -28,7 +28,14 @@ export function processHeaders(request: PublishRequest) {
   headers.set("Upstash-Method", request.method ?? "POST");
 
   if (request.delay !== undefined) {
-    headers.set("Upstash-Delay", `${request.delay.toFixed(0)}s`);
+    // Handle both string (Duration type) and number inputs for delay
+    if (typeof request.delay === "string") {
+      // If delay is a string (e.g., "20s", "1h"), use it directly
+      headers.set("Upstash-Delay", request.delay);
+    } else {
+      // If delay is a number, convert it to seconds and append 's'
+      headers.set("Upstash-Delay", `${request.delay.toFixed(0)}s`);
+    }
   }
 
   if (request.notBefore !== undefined) {
@@ -56,7 +63,14 @@ export function processHeaders(request: PublishRequest) {
   }
 
   if (request.timeout !== undefined) {
-    headers.set("Upstash-Timeout", `${request.timeout}s`);
+    // Handle both string (Duration type) and number inputs for timeout
+    if (typeof request.timeout === "string") {
+      // If timeout is a string (e.g., "20s", "1h"), use it directly
+      headers.set("Upstash-Timeout", request.timeout);
+    } else {
+      // If timeout is a number, convert it to seconds and append 's'
+      headers.set("Upstash-Timeout", `${request.timeout}s`);
+    }
   }
 
   return headers;