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

50 lines
1.4 KiB
TypeScript

import { CommandParser } from '../client/parser';
import { RedisVariadicArgument } from './generic-transformers';
import { ArrayReply, Command, BlobStringReply, NullReply, RedisArgument } from '../RESP/types';
export interface HGetExOptions {
expiration?: {
type: 'EX' | 'PX' | 'EXAT' | 'PXAT';
value: number;
} | {
type: 'PERSIST';
} | 'PERSIST';
}
export default {
/**
* Gets the values of the specified fields in a hash and optionally sets their expiration
* @param parser - The Redis command parser
* @param key - Key of the hash
* @param fields - Fields to get values from
* @param options - Options for setting expiration
*/
parseCommand(
parser: CommandParser,
key: RedisArgument,
fields: RedisVariadicArgument,
options?: HGetExOptions
) {
parser.push('HGETEX');
parser.pushKey(key);
if (options?.expiration) {
if (typeof options.expiration === 'string') {
parser.push(options.expiration);
} else if (options.expiration.type === 'PERSIST') {
parser.push('PERSIST');
} else {
parser.push(
options.expiration.type,
options.expiration.value.toString()
);
}
}
parser.push('FIELDS')
parser.pushVariadicWithLength(fields);
},
transformReply: undefined as unknown as () => ArrayReply<BlobStringReply | NullReply>
} as const satisfies Command;