upstash · chronark · Oct 31, 2022 · Oct 31, 2022
diff --git a/pkg/commands/getdel.test.ts b/pkg/commands/getdel.test.ts
@@ -0,0 +1,48 @@
+import { keygen, newHttpClient, randomID } from "../test-utils.ts";
+
+import { afterAll } from "https://deno.land/[email protected]/testing/bdd.ts";
+import { SetCommand } from "./set.ts";
+import { assertEquals } from "https://deno.land/[email protected]/testing/asserts.ts";
+import { GetDelCommand } from "./getdel.ts";
+import { GetCommand } from "./get.ts";
+const client = newHttpClient();
+
+const { newKey, cleanup } = keygen();
+afterAll(cleanup);
+
+Deno.test(
+  "gets an exiting value, then deletes",
+  async () => {
+    const key = newKey();
+    const value = randomID();
+    await new SetCommand([key, value]).exec(client);
+    const res = await new GetDelCommand([key]).exec(client);
+
+    assertEquals(res, value);
+
+    const res2 = await new GetCommand([key]).exec(client);
+    assertEquals(res2, null);
+  },
+);
+
+Deno.test(
+  "gets a non-existing value",
+  async () => {
+    const key = newKey();
+    const res = await new GetDelCommand([key]).exec(client);
+
+    assertEquals(res, null);
+  },
+);
+
+Deno.test(
+  "gets an object",
+  async () => {
+    const key = newKey();
+    const value = { v: randomID() };
+    await new SetCommand([key, value]).exec(client);
+    const res = await new GetDelCommand<{ v: string }>([key]).exec(client);
+
+    assertEquals(res, value);
+  },
+);
diff --git a/pkg/commands/getdel.ts b/pkg/commands/getdel.ts
@@ -0,0 +1,16 @@
+import { Command, CommandOptions } from "./command.ts";
+
+/**
+ * @see https://redis.io/commands/getdel
+ */
+export class GetDelCommand<TData = string> extends Command<
+  unknown | null,
+  TData | null
+> {
+  constructor(
+    cmd: [key: string],
+    opts?: CommandOptions<unknown | null, TData | null>,
+  ) {
+    super(["getdel", ...cmd], opts);
+  }
+}
diff --git a/pkg/commands/mod.ts b/pkg/commands/mod.ts
@@ -19,6 +19,7 @@ export * from "./get.ts";
 export * from "./getbit.ts";
 export * from "./getrange.ts";
 export * from "./getset.ts";
+export * from "./getdel.ts";
 export * from "./hdel.ts";
 export * from "./hexists.ts";
 export * from "./hget.ts";

diff --git a/pkg/commands/scan.test.ts b/pkg/commands/scan.test.ts
@@ -20,7 +20,6 @@ Deno.test("without options", async (t) => {
     const found: string[] = [];
     do {
       const res = await new ScanCommand([cursor]).exec(client);
-      assertEquals(typeof res[0], "number");
       cursor = res[0];
       found.push(...res[1]);
     } while (cursor != 0);

diff --git a/pkg/pipeline.test.ts b/pkg/pipeline.test.ts
@@ -116,6 +116,7 @@ Deno.test("use all the things", async (t) => {
       .flushdb()
       .get(newKey())
       .getbit(newKey(), 0)
+      .getdel(newKey())
       .getrange(newKey(), 0, 1)
       .getset(newKey(), "hello")
       .hdel(newKey(), "field")
@@ -214,6 +215,6 @@ Deno.test("use all the things", async (t) => {
       .zunionstore(newKey(), 1, [newKey()]);
 
     const res = await p.exec();
-    assertEquals(res.length, 114);
+    assertEquals(res.length, 115);
   });
 });
diff --git a/pkg/pipeline.ts b/pkg/pipeline.ts
@@ -17,6 +17,7 @@ import {
   FlushDBCommand,
   GetBitCommand,
   GetCommand,
+  GetDelCommand,
   GetRangeCommand,
   GetSetCommand,
   HDelCommand,
@@ -351,7 +352,11 @@ export class Pipeline {
    */
   getbit = (...args: CommandArgs<typeof GetBitCommand>) =>
     this.chain(new GetBitCommand(args, this.commandOptions));
-
+  /**
+   * @see https://redis.io/commands/getdel
+   */
+  getdel = <TData>(...args: CommandArgs<typeof GetDelCommand>) =>
+    this.chain(new GetDelCommand<TData>(args, this.commandOptions));
   /**
    * @see https://redis.io/commands/getrange
    */

diff --git a/pkg/redis.ts b/pkg/redis.ts
@@ -18,6 +18,7 @@ import {
   FlushDBCommand,
   GetBitCommand,
   GetCommand,
+  GetDelCommand,
   GetRangeCommand,
   GetSetCommand,
   HDelCommand,
@@ -329,6 +330,11 @@ export class Redis {
    */
   getbit = (...args: CommandArgs<typeof GetBitCommand>) =>
     new GetBitCommand(args, this.opts).exec(this.client);
+  /**
+   * @see https://redis.io/commands/getdel
+   */
+  getdel = <TData>(...args: CommandArgs<typeof GetDelCommand>) =>
+    new GetDelCommand<TData>(args, this.opts).exec(this.client);
 
   /**
    * @see https://redis.io/commands/getrange