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

73 lines
2.2 KiB
TypeScript

import { CommandParser } from '../client/parser';
import { NullReply, TuplesReply, BlobStringReply, DoubleReply, ArrayReply, UnwrapReply, Resp2Reply, Command, TypeMapping } from '../RESP/types';
import { RedisVariadicArgument, SortedSetSide, transformSortedSetReply, transformDoubleReply, Tail } from './generic-transformers';
export interface ZMPopOptions {
COUNT?: number;
}
export type ZMPopRawReply = NullReply | TuplesReply<[
key: BlobStringReply,
members: ArrayReply<TuplesReply<[
value: BlobStringReply,
score: DoubleReply
]>>
]>;
export function parseZMPopArguments(
parser: CommandParser,
keys: RedisVariadicArgument,
side: SortedSetSide,
options?: ZMPopOptions
) {
parser.pushKeysLength(keys);
parser.push(side);
if (options?.COUNT) {
parser.push('COUNT', options.COUNT.toString());
}
}
export type ZMPopArguments = Tail<Parameters<typeof parseZMPopArguments>>;
export default {
IS_READ_ONLY: false,
/**
* Removes and returns up to count members with the highest/lowest scores from the first non-empty sorted set.
* @param parser - The Redis command parser.
* @param keys - Keys of the sorted sets to pop from.
* @param side - Side to pop from (MIN or MAX).
* @param options - Optional parameters including COUNT.
*/
parseCommand(
parser: CommandParser,
keys: RedisVariadicArgument,
side: SortedSetSide,
options?: ZMPopOptions
) {
parser.push('ZMPOP');
parseZMPopArguments(parser, keys, side, options)
},
transformReply: {
2(reply: UnwrapReply<Resp2Reply<ZMPopRawReply>>, preserve?: any, typeMapping?: TypeMapping) {
return reply === null ? null : {
key: reply[0],
members: (reply[1] as unknown as UnwrapReply<typeof reply[1]>).map(member => {
const [value, score] = member as unknown as UnwrapReply<typeof member>;
return {
value,
score: transformDoubleReply[2](score, preserve, typeMapping)
};
})
};
},
3(reply: UnwrapReply<ZMPopRawReply>) {
return reply === null ? null : {
key: reply[0],
members: transformSortedSetReply[3](reply[1])
};
}
}
} as const satisfies Command;