fix(command): fixed optional step for INCR-like commands

Author: fenying

CHANGES.md

@@ -1,5 +1,9 @@
 # Changes Logs
 
+## v3.0.5
+
+- fix(command): fixed optional step for `INCR-like` commands.
+
 ## v3.0.4
 
 - fix(protocol): ensure writing network and queue in sync, avoiding disorder of execution queue.

eslint.config.js

@@ -5,7 +5,7 @@ module.exports = [
     ...LitertEslintRules.configs.typescript,
     {
         plugins: {
-            '@litert/rules': require('@litert/eslint-plugin-rules'),
+            '@litert/rules': LitertEslintRules,
         },
         files: [
             'src/lib/**/*.ts',

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@litert/redis",
-  "version": "3.0.4",
+  "version": "3.0.5",
   "description": "A redis protocol implement for Node.js.",
   "main": "./lib/index.js",
   "scripts": {
@@ -33,12 +33,12 @@
   "types": "./lib/index.d.ts",
   "typings": "./lib/index.d.ts",
   "devDependencies": {
-    "@commitlint/cli": "^19.4.1",
-    "@commitlint/config-conventional": "^19.4.1",
-    "@litert/eslint-plugin-rules": "^0.2.0",
-    "@types/node": "^22.5.1",
-    "husky": "^9.1.5",
-    "typescript": "^5.6.3"
+    "@commitlint/cli": "^19.6.1",
+    "@commitlint/config-conventional": "^19.6.0",
+    "@litert/eslint-plugin-rules": "^0.2.5",
+    "@types/node": "^22.10.2",
+    "husky": "^9.1.7",
+    "typescript": "^5.7.2"
   },
   "engines": {
     "node": ">=16.0.0"

package.json

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+/* eslint-disable max-lines */
+
 import * as C from './Common';
 import * as U from './Utils';
 import * as E from './Errors';
@@ -77,7 +79,7 @@ export const COMMANDS: Record<keyof C.ICommandAPIs, ICommand> = {
         },
         process(data: Buffer | string): string {
 
-            return data instanceof Buffer ? data.toString() : data;
+            return data instanceof Buffer ? data.toString() : data as string;
         }
     },
 
@@ -146,61 +148,59 @@ export const COMMANDS: Record<keyof C.ICommandAPIs, ICommand> = {
      * @see https://redis.io/docs/latest/commands/incr
      */
     'incr': {
-        prepare(key: string, step: number): IPrepareResult {
+        prepare(key: string, step: number = 1): IPrepareResult {
 
             return {
                 'cmd': 'INCRBY',
-                'args': [key, step || 1]
+                'args': [key, step]
             };
-        }
+        },
+        // process: parseInt, // always returning integer
     },
 
     /**
      * Command: incrByFloat
      * @see https://redis.io/docs/latest/commands/incrbyfloat
      */
     'incrByFloat': {
-        prepare(key: string, step: number): IPrepareResult {
+        prepare(key: string, step: number = 1): IPrepareResult {
 
             return {
                 'cmd': 'INCRBYFLOAT',
                 'args': [key, step]
             };
         },
-        process(data: Buffer | string): number {
-            return parseFloat(data as string);
-        }
+        process: parseFloat,
     },
 
     /**
      * Command: decr
      * @see https://redis.io/docs/latest/commands/decr
      */
     'decr': {
-        prepare(key: string, step: number): IPrepareResult {
+        prepare(key: string, step: number = 1): IPrepareResult {
 
             return {
                 'cmd': 'DECRBY',
                 'args': [key, step]
             };
-        }
+        },
+        // process: parseInt, // always returning integer
     },
 
     /**
      * Command: incrByFloat
      * @see https://redis.io/docs/latest/commands/incrbyfloat
      */
     'decrByFloat': {
-        prepare(key: string, step: number): IPrepareResult {
+        prepare(key: string, step: number = 1): IPrepareResult {
 
             return {
                 'cmd': 'INCRBYFLOAT',
                 'args': [key, -step]
             };
         },
-        process(data: string | Buffer): number {
-            return parseFloat(data as string);
-        }
+        process: parseFloat,
     },
 
     /**
@@ -987,7 +987,7 @@ export const COMMANDS: Record<keyof C.ICommandAPIs, ICommand> = {
     'mSet': {
         prepare(kv: Record<string, string | Buffer>): IPrepareResult {
 
-            const args: any[] = [];
+            const args: Array<string | Buffer> = [];
 
             for (const k in kv) {
 
@@ -1010,7 +1010,7 @@ export const COMMANDS: Record<keyof C.ICommandAPIs, ICommand> = {
     'mSetNX': {
         prepare(kv: Record<string, string | Buffer>): IPrepareResult {
 
-            const args: any[] = [];
+            const args: Array<string | Buffer> = [];
 
             for (const k in kv) {
 
@@ -1031,37 +1031,49 @@ export const COMMANDS: Record<keyof C.ICommandAPIs, ICommand> = {
      * @see https://redis.io/docs/latest/commands/hincrby
      */
     'hIncr': {
-        prepare: createDefaultPreparer('HINCRBY')
+        prepare(key: string, field: string, step: number = 1): IPrepareResult {
+            return {
+                cmd: 'HINCRBY',
+                args: [key, field, step]
+            };
+        },
+        // process: parseInt, // always returning integer
     },
 
     /**
      * Command: hIncrByFloat
      * @see https://redis.io/docs/latest/commands/hincrbyfloat
      */
     'hIncrByFloat': {
-        prepare: createDefaultPreparer('HINCRBYFLOAT'),
-        process: parseFloat
+        prepare(key: string, field: string, step: number = 1): IPrepareResult {
+            return {
+                cmd: 'HINCRBYFLOAT',
+                args: [key, field, step]
+            };
+        },
+        process: parseFloat,
     },
 
     /**
      * Command: hIncr
      * @see https://redis.io/docs/latest/commands/hincrby
      */
     'hDecr': {
-        prepare(key: string, field: string, step: number): IPrepareResult {
+        prepare(key: string, field: string, step: number = 1): IPrepareResult {
             return {
                 cmd: 'HINCRBY',
-                args: [key, field, -(step || 1)]
+                args: [key, field, -step]
             };
-        }
+        },
+        // process: parseInt, // always returning integer
     },
 
     /**
      * Command: hIncrByFloat
      * @see https://redis.io/docs/latest/commands/hincrbyfloat
      */
     'hDecrByFloat': {
-        prepare(key: string, field: string, step: number): IPrepareResult {
+        prepare(key: string, field: string, step: number = 1): IPrepareResult {
             return {
                 cmd: 'HINCRBYFLOAT',
                 args: [key, field, -step]

src/lib/Commands.ts

@@ -1,3 +1,4 @@
+/* eslint-disable max-lines */
 /**
  * Copyright 2024 Angus.Fenying <fenying@litert.org>
  *
@@ -388,27 +389,43 @@ export interface ICommandAPIs {
 
     /**
      * Command: incr
+     *
+     * @param key       The key of the hash.
+     * @param increment The step to increase. [Default: 1]
+     *
      * @see https://redis.io/docs/latest/commands/incr
      */
-    incr(key: string, step?: number): Promise<number>;
+    incr(key: string, increment?: number): Promise<number>;
 
     /**
      * Command: incrByFloat
+     *
+     * @param key       The key of the hash.
+     * @param increment The step to increase. [Default: 1]
+     *
      * @see https://redis.io/docs/latest/commands/incrbyfloat
      */
-    incrByFloat(key: string, step: number): Promise<number>;
+    incrByFloat(key: string, increment?: number): Promise<number>;
 
     /**
      * Command: decr
+     *
+     * @param key       The key of the hash.
+     * @param decrement The step to decrease. [Default: 1]
+     *
      * @see https://redis.io/docs/latest/commands/decr
      */
-    decr(key: string, step?: number): Promise<number>;
+    decr(key: string, decrement?: number): Promise<number>;
 
     /**
      * Command: incrByFloat
+     *
+     * @param key       The key of the hash.
+     * @param decrement The step to decrease. [Default: 1]
+     *
      * @see https://redis.io/docs/latest/commands/incrbyfloat
      */
-    decrByFloat(key: string, step: number): Promise<number>;
+    decrByFloat(key: string, decrement?: number): Promise<number>;
 
     /**
      * Command: del
@@ -815,27 +832,47 @@ export interface ICommandAPIs {
 
     /**
      * Command: hIncr
+     *
+     * @param key       The key of the hash.
+     * @param field     The field of the hash.
+     * @param increment The step to increase. [Default: 1]
+     *
      * @see https://redis.io/docs/latest/commands/hincrby
      */
-    hIncr(key: string, field: string, step?: number): Promise<number>;
+    hIncr(key: string, field: string, increment?: number): Promise<number>;
 
     /**
-     * Command: hIncr
+     * Command: hIncrByFloat
+     *
+     * @param key       The key of the hash.
+     * @param field     The field of the hash.
+     * @param increment The step to increase. [Default: 1]
+     *
      * @see https://redis.io/docs/latest/commands/hincrbyfloat
      */
-    hIncrByFloat(key: string, field: string, step: number): Promise<number>;
+    hIncrByFloat(key: string, field: string, increment?: number): Promise<number>;
 
     /**
      * Command: hIncr
+     *
+     * @param key       The key of the hash.
+     * @param field     The field of the hash.
+     * @param decrement The step to decrease. [Default: 1]
+     *
      * @see https://redis.io/docs/latest/commands/hincrby
      */
-    hDecr(key: string, field: string, step?: number): Promise<number>;
+    hDecr(key: string, field: string, decrement?: number): Promise<number>;
 
     /**
-     * Command: hIncr
+     * Command: hIncrByFloat
+     *
+     * @param key       The key of the hash.
+     * @param field     The field of the hash.
+     * @param decrement The step to decrease. [Default: 1]
+     *
      * @see https://redis.io/docs/latest/commands/hincrbyfloat
      */
-    hDecrByFloat(key: string, field: string, step: number): Promise<number>;
+    hDecrByFloat(key: string, field: string, decrement?: number): Promise<number>;
 
     /**
      * Command: hKeys

src/lib/Common.ts

@@ -1,3 +1,4 @@
+/* eslint-disable max-lines */
 /**
  * Copyright 2024 Angus.Fenying <fenying@litert.org>
  *