feat: implement Symbol.dispose

denodrivers · Oct 26, 2023 · 7328921 · 7328921
1 parent 07104b0
commit 7328921
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/redis.ts b/redis.ts
@@ -112,6 +112,7 @@ export interface Redis extends RedisCommands {
   ): Promise<RedisReply>;
   connect(): Promise<void>;
   close(): void;
+  [Symbol.dispose](): void;
 }
 
 class RedisImpl implements Redis {
@@ -142,7 +143,11 @@ class RedisImpl implements Redis {
   }
 
   close(): void {
-    this.executor.close();
+    return this.executor.close();
+  }
+
+  [Symbol.dispose](): void {
+    return this.close();
   }
 
   async execReply<T extends Raw = Raw>(

diff --git a/tests/commands/connection.ts b/tests/commands/connection.ts
@@ -143,6 +143,14 @@ export function connectionTests(
       client.close();
     });
   });
+
+  describe("using", () => {
+    it("implements `Symbol.dispose`", async () => {
+      using client = await connect(getOpts());
+      assert(client.isConnected);
+      assert(!client.isClosed);
+    });
+  });
 }
 
 function parseCommandStats(