You've already forked node-redis
mirror of
https://github.com/redis/node-redis.git
synced 2025-08-03 04:01:40 +03:00
20c16e0c2c
* (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
48 lines
1.6 KiB
TypeScript
48 lines
1.6 KiB
TypeScript
import { CommandParser } from '../client/parser';
|
|
import { ArrayReply, Command, RedisArgument } from '../RESP/types';
|
|
import { RedisVariadicArgument } from './generic-transformers';
|
|
|
|
export const HASH_EXPIRATION = {
|
|
/** The field does not exist */
|
|
FIELD_NOT_EXISTS: -2,
|
|
/** Specified NX | XX | GT | LT condition not met */
|
|
CONDITION_NOT_MET: 0,
|
|
/** Expiration time was set or updated */
|
|
UPDATED: 1,
|
|
/** Field deleted because the specified expiration time is in the past */
|
|
DELETED: 2
|
|
} as const;
|
|
|
|
export type HashExpiration = typeof HASH_EXPIRATION[keyof typeof HASH_EXPIRATION];
|
|
|
|
export default {
|
|
/**
|
|
* Sets a timeout on hash fields. After the timeout has expired, the fields will be automatically deleted
|
|
* @param parser - The Redis command parser
|
|
* @param key - Key of the hash
|
|
* @param fields - Fields to set expiration on
|
|
* @param seconds - Number of seconds until field expiration
|
|
* @param mode - Expiration mode: NX (only if field has no expiry), XX (only if field 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,
|
|
fields: RedisVariadicArgument,
|
|
seconds: number,
|
|
mode?: 'NX' | 'XX' | 'GT' | 'LT'
|
|
) {
|
|
parser.push('HEXPIRE');
|
|
parser.pushKey(key);
|
|
parser.push(seconds.toString());
|
|
|
|
if (mode) {
|
|
parser.push(mode);
|
|
}
|
|
|
|
parser.push('FIELDS');
|
|
|
|
parser.pushVariadicWithLength(fields);
|
|
},
|
|
transformReply: undefined as unknown as () => ArrayReply<HashExpiration>
|
|
} as const satisfies Command;
|