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

40 lines
1.4 KiB
TypeScript

import { CommandParser } from '../client/parser';
import { NullReply, TuplesReply, BlobStringReply, DoubleReply, UnwrapReply, Command, TypeMapping } from '../RESP/types';
import { RedisVariadicArgument, transformDoubleReply } from './generic-transformers';
export default {
IS_READ_ONLY: false,
/**
* Removes and returns the member with the highest score in a sorted set, or blocks until one is available
* @param parser - The Redis command parser
* @param keys - Key of the sorted set, or array of keys to try sequentially
* @param timeout - Maximum seconds to block, 0 to block indefinitely
*/
parseCommand(parser: CommandParser, keys: RedisVariadicArgument, timeout: number) {
parser.push('BZPOPMAX');
parser.pushKeys(keys);
parser.push(timeout.toString());
},
transformReply: {
2(
reply: UnwrapReply<NullReply | TuplesReply<[BlobStringReply, BlobStringReply, BlobStringReply]>>,
preserve?: any,
typeMapping?: TypeMapping
) {
return reply === null ? null : {
key: reply[0],
value: reply[1],
score: transformDoubleReply[2](reply[2], preserve, typeMapping)
};
},
3(reply: UnwrapReply<NullReply | TuplesReply<[BlobStringReply, BlobStringReply, DoubleReply]>>) {
return reply === null ? null : {
key: reply[0],
value: reply[1],
score: reply[2]
};
}
}
} as const satisfies Command;