1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-03 04:01:40 +03:00
Files
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

28 lines
980 B
TypeScript

import { CommandParser } from '../client/parser';
import { RedisArgument, NumberReply, Command } from '../RESP/types';
export default {
IS_READ_ONLY: true,
/**
* Sets a timeout on key. After the timeout has expired, the key will be automatically deleted
* @param parser - The Redis command parser
* @param key - Key to set expiration on
* @param seconds - Number of seconds until key expiration
* @param mode - Expiration mode: NX (only if key has no expiry), XX (only if key has existing expiry), GT (only if new expiry is greater than current), LT (only if new expiry is less than current)
*/
parseCommand(
parser: CommandParser,
key: RedisArgument,
seconds: number,
mode?: 'NX' | 'XX' | 'GT' | 'LT'
) {
parser.push('EXPIRE');
parser.pushKey(key);
parser.push(seconds.toString());
if (mode) {
parser.push(mode);
}
},
transformReply: undefined as unknown as () => NumberReply
} as const satisfies Command;