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

27 lines
966 B
TypeScript

import { CommandParser } from '../client/parser';
import { UnwrapReply, NullReply, TuplesReply, BlobStringReply, Command } from '../RESP/types';
import { RedisVariadicArgument } from './generic-transformers';
export default {
IS_READ_ONLY: true,
/**
* Removes and returns the first element in a list, or blocks until one is available
* @param parser - The Redis command parser
* @param key - Key of the list to pop from, or array of keys to try sequentially
* @param timeout - Maximum seconds to block, 0 to block indefinitely
*/
parseCommand(parser: CommandParser, key: RedisVariadicArgument, timeout: number) {
parser.push('BLPOP');
parser.pushKeys(key);
parser.push(timeout.toString());
},
transformReply(reply: UnwrapReply<NullReply | TuplesReply<[BlobStringReply, BlobStringReply]>>) {
if (reply === null) return null;
return {
key: reply[0],
element: reply[1]
};
}
} as const satisfies Command;