feat: add SetReply (#459)

denodrivers · Oct 27, 2024 · 176db18 · 176db18
1 parent 651282c
commit 176db18
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 58 deletions.
diff --git a/command.ts b/command.ts
@@ -141,6 +141,13 @@ export interface SetOpts {
    */
   get?: boolean;
 }
+/** Return type for {@linkcode RedisCommands.set} */
+export type SetReply<T extends SetOpts | SetWithModeOpts> = T extends
+  { get: true } ? SimpleString | BulkNil
+  : T extends { nx: true } ? SimpleString | BulkNil
+  : T extends { xx: true } ? SimpleString | BulkNil
+  : T extends SetWithModeOpts ? SimpleString | BulkNil
+  : SimpleString;
 
 /**
  * @deprecated Use {@linkcode SetOpts.nx}/{@linkcode SetOpts.xx} instead. This type will be removed in the future.
@@ -366,32 +373,11 @@ export interface RedisCommands {
     milliseconds: number,
     value: RedisValue,
   ): Promise<SimpleString>;
-  set(
+  set<TSetOpts extends SetOpts | SetWithModeOpts = SetOpts>(
     key: string,
     value: RedisValue,
-    opts?: Omit<SetOpts, "get" | "nx" | "xx"> & {
-      get?: false | null;
-      nx?: false | null;
-      xx?: false | null;
-    },
-  ): Promise<SimpleString>;
-  set(
-    key: string,
-    value: RedisValue,
-    opts?: (Omit<SetOpts, "get"> & { get: true }) | SetWithModeOpts,
-  ): Promise<SimpleString | BulkNil>;
-  /** Executes `SET` command with `NX` option enabled. */
-  set(
-    key: string,
-    value: RedisValue,
-    opts?: Omit<SetOpts, "nx"> & { nx: true },
-  ): Promise<SimpleString | BulkNil>;
-  /** Executes `SET` command with `XX` option enabled. */
-  set(
-    key: string,
-    value: RedisValue,
-    opts?: Omit<SetOpts, "xx"> & { xx: true },
-  ): Promise<SimpleString | BulkNil>;
+    opts?: TSetOpts,
+  ): Promise<SetReply<TSetOpts>>;
   setbit(key: string, offset: number, value: RedisValue): Promise<Integer>;
   setex(key: string, seconds: number, value: RedisValue): Promise<SimpleString>;
   setnx(key: string, value: RedisValue): Promise<Integer>;

diff --git a/mod.ts b/mod.ts
@@ -37,6 +37,7 @@ export type {
   ScanOpts,
   ScriptDebugMode,
   SetOpts,
+  SetReply,
   SetWithModeOpts,
   ShutdownMode,
   SortOpts,

diff --git a/redis.ts b/redis.ts
@@ -24,6 +24,7 @@ import type {
   ScanOpts,
   ScriptDebugMode,
   SetOpts,
+  SetReply,
   SetWithModeOpts,
   ShutdownMode,
   SortOpts,
@@ -1345,41 +1346,11 @@ class RedisImpl implements Redis {
     return this.execStatusReply("SELECT", index);
   }
 
-  set(
+  set<TSetOpts extends SetOpts | SetWithModeOpts = SetOpts>(
     key: string,
     value: RedisValue,
-    opts?: Omit<SetOpts, "get" | "nx" | "xx"> & {
-      get?: false | null;
-      nx?: false | null;
-      xx?: false | null;
-    },
-  ): Promise<SimpleString>;
-  set(
-    key: string,
-    value: RedisValue,
-    opts?: (Omit<SetOpts, "get"> & { get: true }) | SetWithModeOpts,
-  ): Promise<SimpleString | BulkNil>;
-  set(
-    key: string,
-    value: RedisValue,
-    opts?: Omit<SetOpts, "nx"> & { nx: true },
-  ): Promise<SimpleString | BulkNil>;
-  set(
-    key: string,
-    value: RedisValue,
-    opts?: Omit<SetOpts, "xx"> & { xx: true },
-  ): Promise<SimpleString | BulkNil>;
-  set(
-    key: string,
-    value: RedisValue,
-    opts?:
-      | (Omit<SetOpts, "get" | "nx" | "xx"> & {
-        get?: boolean | null;
-        nx?: boolean | null;
-        xx?: boolean | null;
-      })
-      | SetWithModeOpts,
-  ) {
+    opts?: TSetOpts,
+  ): Promise<SetReply<TSetOpts>> {
     const args: RedisValue[] = [key, value];
     if (opts?.ex != null) {
       args.push("EX", opts.ex);
@@ -1409,9 +1380,10 @@ class RedisImpl implements Redis {
     if (opts?.get) {
       args.push("GET");
     }
-    return isAbleToReturnNil
+    const promise = isAbleToReturnNil
       ? this.execStatusOrNilReply("SET", ...args)
       : this.execStatusReply("SET", ...args);
+    return promise as Promise<SetReply<TSetOpts>>;
   }
 
   setbit(key: string, offset: number, value: RedisValue) {