Class BRPopCommand

Available since 2.0.0.

BRPOP key [key ...] timeout

BRPOP is a blocking list pop primitive. It is the blocking version of RPOP because it blocks the connection when there are no elements to pop from any of the given lists. An element is popped from the tail of the first list that is non-empty, with the given keys being checked in the order that they are given.

See TimedEmitter for limitations

See the BLPOP documentation for the exact semantics, since BRPOP is identical to BLPOP with the only difference being that it pops elements from the tail of a list instead of popping from the head.

Return value

Array reply: specifically:

  • A nil multi-bulk when no element could be popped and the timeout expired.
  • A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element.

Examples

redis> DEL list1 list2
(integer) 0
redis> RPUSH list1 a b c
(integer) 3
redis> BRPOP list1 list2 0
1) "list1"
2) "c"

Hierarchy

Constructors

constructor

Properties

Blocking DbDataType blocking? dataType? logger maxParams minParams name pubSubAllowed? sign? txIgnore?

Methods

execSync process removeListeners

Constructors

constructor

Properties

Blocking

Blocking: boolean = true

DbDataType

DbDataType: DataType = DataType.LIST

Optional blocking

blocking?: boolean

Optional dataType

dataType?: DataType

Used for "database" commands to enforce type checking.

Protected logger

logger: Logger

maxParams

maxParams: number = 1

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

minParams

minParams: number = 1

Minimum number of parameters require.

name

name: string = "rpop"

Optional pubSubAllowed

pubSubAllowed?: boolean

Used when PUB/SUB is in effect.

Optional sign

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

Optional txIgnore

txIgnore?: boolean

Used in transactions to enqueue a command.

Methods

execSync

Protected process

Private removeListeners

Settings

Member Visibility

Theme

On This Page