Available since 2.2.0.

BRPOPLPUSH source destination timeout

BRPOPLPUSH is the blocking variant of [RPOPLPUSH]RPoplPushCommand. When source contains elements, this command behaves exactly like RPOPLPUSH. When used inside a MULTI/EXEC block, this command behaves exactly like RPOPLPUSH. When source is empty, Redis will block the connection until another client pushes to it or until timeout is reached. A timeout of zero can be used to block indefinitely.

See [RPOPLPUSH]RPoplPushCommand for more information.

Return value

Bulk string reply: the element being popped from source and pushed to destination. If timeout is reached, a Null reply is returned.

Pattern: Reliable queue

Please see the pattern description in the [RPOPLPUSH]RPoplPushCommand documentation.

Pattern: Circular list

Please see the pattern description in the [RPOPLPUSH]RPoplPushCommand documentation.

Hierarchy

Constructors

Properties

DbDataType: DataType = DataType.LIST
blocking: boolean = true
dataType?: DataType

Used for "database" commands to enforce type checking.

dbDataType: DataType = DataType.LIST
logger: Logger
maxParams: number = 3

Maximum number of parameters allowed. -1 for no maximum.

minParams: number = 3

Minimum number of parameters require.

name: string = "brpoplpush"
pubSubAllowed?: boolean

Used when PUB/SUB is in effect.

sign?: number

Sign is used in commands with a compliment command. The only current example is INCR/DECR. Sign is 1 for INCR and -1 for DECR

txIgnore?: boolean

Used in transactions to enqueue a command.

Methods