1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-04 15:02:09 +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

30 lines
1.1 KiB
TypeScript

import { CommandParser } from '../client/parser';
import { RedisArgument, BlobStringReply, NullReply, Command } from '../RESP/types';
import { ListSide } from './generic-transformers';
export default {
IS_READ_ONLY: false,
/**
* Pop an element from a list, push it to another list and return it; or block until one is available
* @param parser - The Redis command parser
* @param source - Key of the source list
* @param destination - Key of the destination list
* @param sourceSide - Side of source list to pop from (LEFT or RIGHT)
* @param destinationSide - Side of destination list to push to (LEFT or RIGHT)
* @param timeout - Timeout in seconds, 0 to block indefinitely
*/
parseCommand(
parser: CommandParser,
source: RedisArgument,
destination: RedisArgument,
sourceSide: ListSide,
destinationSide: ListSide,
timeout: number
) {
parser.push('BLMOVE');
parser.pushKeys([source, destination]);
parser.push(sourceSide, destinationSide, timeout.toString())
},
transformReply: undefined as unknown as () => BlobStringReply | NullReply
} as const satisfies Command;