fix: Add back Pipeline#length

Closes #1584
redis · May 21, 2022 · b8cee9b · b8cee9b
1 parent 91ed2d8
commit b8cee9b
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 5 deletions.
diff --git a/bin/template.ts b/bin/template.ts
@@ -11,8 +11,9 @@ export interface ResultTypes<Result, Context> {
   pipeline: ChainableCommander;
 }
 
-export interface ChainableCommander
-  extends RedisCommander<{ type: "pipeline" }> {}
+export interface ChainableCommander extends RedisCommander<{ type: "pipeline" }> {
+  length: number;
+}
 
 export type ClientContext = { type: keyof ResultTypes<unknown, unknown> };
 export type Result<T, Context extends ClientContext> =

diff --git a/lib/Pipeline.ts b/lib/Pipeline.ts
@@ -392,3 +392,7 @@ Pipeline.prototype.exec = function (callback: Callback): Promise<Array<any>> {
     return _this.promise;
   }
 };
+
+interface Pipeline {
+  length: number;
+}
diff --git a/lib/utils/RedisCommander.ts b/lib/utils/RedisCommander.ts
@@ -11,8 +11,9 @@ export interface ResultTypes<Result, Context> {
   pipeline: ChainableCommander;
 }
 
-export interface ChainableCommander
-  extends RedisCommander<{ type: "pipeline" }> {}
+export interface ChainableCommander extends RedisCommander<{ type: "pipeline" }> {
+  length: number;
+}
 
 export type ClientContext = { type: keyof ResultTypes<unknown, unknown> };
 export type Result<T, Context extends ClientContext> =

diff --git a/test/functional/pipeline.ts b/test/functional/pipeline.ts
@@ -400,6 +400,7 @@ describe("pipeline", () => {
 
       const pipeline1 = redis
         .pipeline()
+        // @ts-expect-error
         .multi()
         .set("foo", "bar")
         .get("foo")

diff --git a/test/typing/pipeline.test-d.ts b/test/typing/pipeline.test-d.ts
@@ -1,5 +1,5 @@
 import { expectType } from "tsd";
-import Redis from "../../built";
+import Redis, { Pipeline } from "../../built";
 
 const redis = new Redis();
 
@@ -24,3 +24,12 @@ expectType<RETURN_TYPE>(
     ])
     .exec()
 );
+
+expectType<number>(
+  redis.pipeline([
+    ["set", Buffer.from("foo"), "bar"],
+    ["incrby", "foo", 42],
+  ]).length
+);
+
+expectType<number>(({} as unknown as Pipeline).length);