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/PEXPIRE.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

31 lines
831 B
TypeScript

import { CommandParser } from '../client/parser';
import { RedisArgument, NumberReply, Command } from '../RESP/types';
export default {
IS_READ_ONLY: true,
/**
* Constructs the PEXPIRE command
*
* @param parser - The command parser
* @param key - The key to set the expiration for
* @param ms - The expiration time in milliseconds
* @param mode - Optional mode for the command ('NX', 'XX', 'GT', 'LT')
* @see https://redis.io/commands/pexpire/
*/
parseCommand(
parser: CommandParser,
key: RedisArgument,
ms: number,
mode?: 'NX' | 'XX' | 'GT' | 'LT'
) {
parser.push('PEXPIRE');
parser.pushKey(key);
parser.push(ms.toString());
if (mode) {
parser.push(mode);
}
},
transformReply: undefined as unknown as () => NumberReply
} as const satisfies Command;