1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-03 04:01:40 +03:00
Files
node-redis/packages/client/lib/commands/HPEXPIRE.ts
Bobby I. 20c16e0c2c (docs) add jsdoc comments to command parsers (#2984)
* (docs) bloom: add jsdocs for all commands

* (docs) json: add jsdocs

* (docs) search: add jsdocs for all commands

* (docs) jsdocs for std commands

* (docs) jsdoc comments to time series commands
2025-06-03 14:38:07 +03:00

37 lines
1.1 KiB
TypeScript

import { CommandParser } from '../client/parser';
import { ArrayReply, Command, NullReply, RedisArgument } from '../RESP/types';
import { RedisVariadicArgument } from './generic-transformers';
import { HashExpiration } from './HEXPIRE';
export default {
/**
* Parses the arguments for the `HPEXPIRE` command.
*
* @param parser - The command parser instance.
* @param key - The key of the hash.
* @param fields - The fields to set the expiration for.
* @param ms - The expiration time in milliseconds.
* @param mode - Optional mode for the command ('NX', 'XX', 'GT', 'LT').
*/
parseCommand(
parser: CommandParser,
key: RedisArgument,
fields: RedisVariadicArgument,
ms: number,
mode?: 'NX' | 'XX' | 'GT' | 'LT',
) {
parser.push('HPEXPIRE');
parser.pushKey(key);
parser.push(ms.toString());
if (mode) {
parser.push(mode);
}
parser.push('FIELDS')
parser.pushVariadicWithLength(fields);
},
transformReply: undefined as unknown as () => ArrayReply<HashExpiration> | NullReply
} as const satisfies Command;