feat(command): added count param of RPOP and LPOP

Author: fenying

CHANGES.md

@@ -3,6 +3,7 @@
 ## v1.2.4
 
 - feat(command): added command `HRANDFILED` supports.
+- feat(command): added `count` param of command `R/LPOP`.
 
 ## v1.2.3
 

src/examples/debug.ts

@@ -58,6 +58,12 @@ function sleep(ms: number): Promise<void> {
     console.log(await cli.hRandFieldWithValues('aaaa', 2));
     console.log(await cli.hRandFieldWithValues$('aaaa', 2));
 
+    await cli.rPush('list-test', ['1', '2', '3', '4', '5']);
+    console.log(await cli.rPop('list-test'));
+    console.log(await cli.rPop('list-test', 4));
+    console.log(await cli.rPop('list-test'));
+    console.log(await cli.rPop('list-test', 4));
+
     console.log('PING ->', await cli.ping(''));
     console.log('GET ->', await cli.set('a', '123'));
     console.log('INCR ->', await cli.incr('a', 23));

src/lib/Commands.ts

@@ -1688,16 +1688,55 @@ export const COMMANDS: Record<keyof C.ICommandAPIs, ICommand> = {
      * @see https://redis.io/commands/lPop
      */
     'lPop': {
-        prepare: createDefaultPreparer('LPOP'),
-        process: U.buffer2String
+        prepare(key: string, count: number = 1): IPrepareResult {
+
+            return {
+                args: [key, count],
+                cmd: 'LPOP'
+            };
+        },
+        process(data: any, args: any[]): string | null | string[] {
+
+            if (data === null) {
+
+                return args[1] !== '1' ? [] : null;
+            }
+
+            if (data.length === 1) {
+
+                return data[0][1].toString();
+            }
+
+            return U.list2StringList(data);
+        }
     },
 
     /**
      * Command: lPop
      * @see https://redis.io/commands/lPop
      */
     'lPop$': {
-        prepare: createDefaultPreparer('LPOP')
+        prepare(key: string, count: number = 1): IPrepareResult {
+
+            return {
+                args: [key, count],
+                cmd: 'LPOP'
+            };
+        },
+        process(data: any, args: any[]): Buffer | null | Buffer[] {
+
+            if (data === null) {
+
+                return null;
+            }
+
+            if (data.length === 1) {
+
+                return args[1] !== '1' ? [] : null;
+            }
+
+            return U.list2BufferList(data);
+        }
     },
 
     /**
@@ -1777,16 +1816,55 @@ export const COMMANDS: Record<keyof C.ICommandAPIs, ICommand> = {
      * @see https://redis.io/commands/rPop
      */
     'rPop': {
-        prepare: createDefaultPreparer('RPOP'),
-        process: U.buffer2String
+        prepare(key: string, count: number = 1): IPrepareResult {
+
+            return {
+                args: [key, count],
+                cmd: 'RPOP'
+            };
+        },
+        process(data: any, args: any[]): string | null | string[] {
+
+            if (data === null) {
+
+                return args[1] !== '1' ? [] : null;
+            }
+
+            if (data.length === 1) {
+
+                return data[0][1].toString();
+            }
+
+            return U.list2StringList(data);
+        }
     },
 
     /**
      * Command: rPop
      * @see https://redis.io/commands/rPop
      */
     'rPop$': {
-        prepare: createDefaultPreparer('RPOP')
+        prepare(key: string, count: number = 1): IPrepareResult {
+
+            return {
+                args: [key, count],
+                cmd: 'RPOP'
+            };
+        },
+        process(data: any, args: any[]): Buffer | null | Buffer[] {
+
+            if (data === null) {
+
+                return null;
+            }
+
+            if (data.length === 1) {
+
+                return args[1] !== '1' ? [] : null;
+            }
+
+            return U.list2BufferList(data);
+        }
     },
 
     /**

src/lib/Common.ts

@@ -838,12 +838,24 @@ export interface ICommandAPIs {
      */
     lPop(key: string): Promise<string | null>;
 
+    /**
+     * Command: lPop
+     * @see https://redis.io/commands/lPop
+     */
+    lPop(key: string, count: number): Promise<string[]>;
+
     /**
      * Command: lPop
      * @see https://redis.io/commands/lPop
      */
     lPop$(key: string): Promise<Buffer | null>;
 
+    /**
+     * Command: lPop
+     * @see https://redis.io/commands/lPop
+     */
+    lPop$(key: string, count: number): Promise<Buffer[]>;
+
     /**
      * Command: lPush
      * @see https://redis.io/commands/lPush
@@ -892,12 +904,24 @@ export interface ICommandAPIs {
      */
     rPop(key: string): Promise<string | null>;
 
+    /**
+     * Command: rPop
+     * @see https://redis.io/commands/rPop
+     */
+    rPop(key: string, count: number): Promise<string[]>;
+
     /**
      * Command: rPop
      * @see https://redis.io/commands/rPop
      */
     rPop$(key: string): Promise<Buffer | null>;
 
+    /**
+     * Command: rPop
+     * @see https://redis.io/commands/rPop
+     */
+    rPop$(key: string, count: number): Promise<Buffer[]>;
+
     /**
      * Command: rPopLPush
      * @see https://redis.io/commands/rPopLPush