HSCAN VALUES support (v5)

Author: sjpotter

packages/client/lib/commands/HSCAN_VALUES.spec.ts

@@ -0,0 +1,56 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../test-utils';
+import HSCAN_VALUES from './HSCAN_VALUES';
+
+describe('HSCAN_VALUES', () => {
+  describe('transformArguments', () => {
+    it('cusror only', () => {
+      assert.deepEqual(
+        HSCAN_VALUES.transformArguments('key', '0'),
+        ['HSCAN', 'key', '0', 'VALUES']
+      );
+    });
+
+    it('with MATCH', () => {
+      assert.deepEqual(
+        HSCAN_VALUES.transformArguments('key', '0', {
+          MATCH: 'pattern'
+        }),
+        ['HSCAN', 'key', '0', 'MATCH', 'pattern', 'VALUES']
+      );
+    });
+
+    it('with COUNT', () => {
+      assert.deepEqual(
+        HSCAN_VALUES.transformArguments('key', '0', {
+          COUNT: 1
+        }),
+        ['HSCAN', 'key', '0', 'COUNT', '1', 'VALUES']
+      );
+    });
+
+    it('with MATCH & COUNT', () => {
+      assert.deepEqual(
+        HSCAN_VALUES.transformArguments('key', '0', {
+          MATCH: 'pattern',
+          COUNT: 1
+        }),
+        ['HSCAN', 'key', '0', 'MATCH', 'pattern', 'COUNT', '1', 'VALUES']
+      );
+    });
+  });
+
+  testUtils.testWithClient('client.hScanValues', async client => {
+    const [, reply] = await Promise.all([
+      client.hSet('key', 'field', 'value'),
+      client.hScanValues('key', '0')
+    ]);
+
+    assert.deepEqual(reply, {
+      cursor: '0',
+      entries: [
+        'field',
+      ]
+    });
+  }, GLOBAL.SERVERS.OPEN);
+});

packages/client/lib/commands/HSCAN_VALUES.ts

@@ -0,0 +1,18 @@
+import { RedisArgument, BlobStringReply, Command } from '../RESP/types';
+import { ScanCommonOptions, pushScanArguments } from './SCAN';
+
+export default {
+  FIRST_KEY_INDEX: 1,
+  IS_READ_ONLY: true,
+  transformArguments(
+    key: RedisArgument,
+    cursor: RedisArgument,
+    options?: ScanCommonOptions
+  ) {
+    const args = pushScanArguments(['HSCAN', key], cursor, options);
+    args.push('VALUES');
+
+    return args;
+  },
+  transformReply: undefined as unknown as () => [BlobStringReply, Array<BlobStringReply>]
+} as const satisfies Command;

packages/client/lib/commands/index.ts

@@ -144,6 +144,7 @@ import HRANDFIELD_COUNT_WITHVALUES from './HRANDFIELD_COUNT_WITHVALUES';
 import HRANDFIELD_COUNT from './HRANDFIELD_COUNT';
 import HRANDFIELD from './HRANDFIELD';
 import HSCAN from './HSCAN';
+import HSCAN_VALUES from './HSCAN_VALUES';
 import HSET from './HSET';
 import HSETNX from './HSETNX';
 import HSTRLEN from './HSTRLEN';
@@ -623,6 +624,8 @@ export default {
   hRandField: HRANDFIELD,
   HSCAN,
   hScan: HSCAN,
+  HSCAN_VALUES,
+  hScanValues: HSCAN_VALUES,
   HSET,
   hSet: HSET,
   HSETNX,